Merge pull request #21 from adam-palazzo/feat/docs

Update Community Documentation

Author: RichardLitt

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [community@orbitdb.org](mailto:community@orbitdb.org), which goes to all members of the @OrbitDB community team, or to [richardlitt@orbitdb.org](mailto:richardlitt@orbitdb.org), which goes only to [@RichardLitt](https://github.com/RichardLitt) or to [haadcode@orbitdb.org](mailto:haadcode@orbitdb.org), which goes only to [@haadcode](https://github.com/haadcode). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+.
+# Contribute
+
+Please contribute! Here are some things that would be great:
+
+- [Open an issue!](https://github.com/orbitdb/orbit-db-docstore/issues/new)
+- Open a pull request!
+- Say hi! :wave:
+
+Please note that we have a [Code of Conduct](CODE_OF_CONDUCT.md), and that all activity in the [@OrbitDB](https://github.com/orbitdb) organization falls under it. Read it before you contribute, as being part of this community means that you agree to abide by it. Thanks.

README.md

@@ -1,13 +1,26 @@
 # orbit-db-docstore
 
+[![npm](https://img.shields.io/npm/v/orbit-db-docstore.svg)](https://www.npmjs.com/package/orbit-db-docstore)
+[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/orbitdb/Lobby)
+
 > Document Store for orbit-db
 
 Database for storing indexed documents. Stores documents by `_id` field by default but you can also specify a custom field to index by.
 
 *This is a core data store in [orbit-db](https://github.com/haadcode/orbit-db)*
 
+## Table of Contents
+
+	- [Install](#install)
+	- [Usage](#usage)
+	- [API](#api)
+		- [docstore(name, options)](#docstorename-options)
+	- [License](#license)
+
 ## Install
 
+This project uses [npm](https://npmjs.com) and [nodejs](https://nodejs.org)
+
 ```
 npm install orbit-db-docstore
 ```
@@ -25,7 +38,7 @@ const docstore = orbitdb.docstore('db name')
 docstore.put({ _id: 'hello world', doc: 'all the things' })
   .then(() => docstore.put({ _id: 'sup world', doc: 'other things' }))
   .then(() => docstore.get('hello'))
-  .then((value) => console.log(value)) 
+  .then((value) => console.log(value))
   // [{ _id: 'hello world', doc: 'all the things'}]
 
 ```
@@ -38,7 +51,7 @@ const docstore = orbitdb.docstore('db name', { indexBy: 'doc' })
 docstore.put({ _id: 'hello world', doc: 'some things' })
   .then(() => docstore.put({ _id: 'hello universe', doc: 'all the things' }))
   .then(() => docstore.get('all'))
-  .then((value) => console.log(value)) 
+  .then((value) => console.log(value))
   // [{ _id: 'hello universe', doc: 'all the things'}]
 
 ```
@@ -52,7 +65,7 @@ docstore.put({ _id: 'hello world', doc: 'some things', views: 10 })
   .then(() => docstore.put({ _id: 'hello universe', doc: 'all the things', views: 100 }))
   .then(() => docstore.put({ _id: 'sup world', doc: 'other things', views: 5 }))
   .then(() => docstore.query((e)=> e.views > 5))
-  .then((value) => console.log(value)) 
+  .then((value) => console.log(value))
   // [{ _id: 'hello world', doc: 'some things', views: 10}, { _id: 'hello universe', doc: 'all the things', views: 100}]
 ```
 
@@ -62,7 +75,7 @@ docstore.put({ _id: 'hello world', doc: 'some things', views: 10 })
 
 ### docstore(name, options)
 
-  Package: 
+  Package:
   [orbit-db-docstore](https://github.com/shamb0t/orbit-db-docstore)
 
   ```javascript
@@ -79,14 +92,14 @@ docstore.put({ _id: 'hello world', doc: 'some things', views: 10 })
     ```javascript
     db.put({ _id: 'QmAwesomeIpfsHash', name: 'shamb0t', followers: 500 }).then((hash) => ...)
     ```
-    
+
   - **get(key)**
     ```javascript
     const profile = db.get('shamb0t')
       .map((e) => e.payload.value)
     // [{ _id: 'shamb0t', name: 'shamb0t', followers: 500 }]
     ```
-    
+
   - **query(mapper)**
     ```javascript
     const all = db.query((doc) => doc.followers >= 500)
@@ -97,7 +110,7 @@ docstore.put({ _id: 'hello world', doc: 'some things', views: 10 })
     ```javascript
     db.del('shamb0t').then((removed) => ...)
     ```
-    
+
   - **events**
 
     ```javascript
@@ -106,6 +119,12 @@ docstore.put({ _id: 'hello world', doc: 'some things', views: 10 })
 
     See [events](https://github.com/haadcode/orbit-db/blob/master/API.md#events) for full description.
 
+## Contributing
+
+If you think this could be better, please [open an issue](https://github.com/orbitdb/orbit-db-docstore/issues/new)!
+
+Please note that all interactions in @orbitdb fall under our [Code of Conduct](CODE_OF_CONDUCT.md).
+
 ## License
 
 [MIT](LICENSE) ©️ 2015-2018 shamb0t, Haja Networks Oy

package.json

@@ -6,6 +6,11 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "keywords": [
+    "orbitdb",
+    "orbit-db"
+    "docstore"
+  ],
   "author": "shamb0t",
   "license": "MIT",
   "dependencies": {