From a5e5771ff5dbec8b8de3c85be68a3d3c8498e0ef Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Tue, 21 Jun 2016 13:05:55 +0100 Subject: [PATCH] Standardized Readme See https://github.com/ipfs/community/issues/124 --- LICENSE | 2 +- README.md | 24 +++++++++++++++++++++--- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/LICENSE b/LICENSE index 96bcd5d..f204902 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License -Copyright (c) 2014 Juan Batiz-Benet +Copyright (c) 2016 Juan Batiz-Benet Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 2baf4b2..eaadf60 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ -# datastore interface +# go-datastore + +[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) +[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/) +[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) +[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) + +> key-value datastore interfaces datastore is a generic layer of abstraction for data store and database access. It is a simple API with the aim to enable application development in a datastore-agnostic way, allowing datastores to be swapped seamlessly without changing application code. Thus, one can leverage different datastores with different strengths without committing the application to one datastore throughout its lifetime. @@ -6,10 +13,21 @@ In addition, grouped datastores significantly simplify interesting data access p Based on [datastore.py](https://github.com/datastore/datastore). -### Documentation +## Documentation https://godoc.org/github.com/jbenet/go-datastore -### License +## Contribute + +Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/NAME/issues)! + +This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). + +### Want to hack on IPFS? + +[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md) + +## License MIT + -- GitLab