Merge pull request #11 from orbitdb/feat/docs-and-linting

Community documentation edits and linting

CODE_OF_CONDUCT.md

@@ -0,0 +1,71 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 [[email protected]](mailto:[email protected]), which goes to all members of the @OrbitDB community team, or to [[email protected]](mailto:[email protected]), which goes only to [@RichardLitt](https://github.com/RichardLitt) or to [[email protected]](mailto:[email protected]), 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

README.md

@@ -1,7 +1,49 @@
 # orbit-db-keystore
 
+[![](https://img.shields.io/badge/freenode-%23orbitdb-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23orbitdb)
+[![npm version](https://badge.fury.io/js/orbit-db-keystore.svg)](https://www.npmjs.com/package/orbit-db-keystore)
+[![node](https://img.shields.io/node/v/orbit-db-keystore.svg)](https://www.npmjs.com/package/orbit-db-keystore)
+
 > A local key manager for orbitdb
 
+## Install
+
+```sh
+$ npm install --save orbit-db-keystore
+```
+
+## Usage
+
+TODO
+
+### Tests
+
+The tests for this repository are included in the [orbitdb/orbit-db](https://github.com/orbitdb/orbit-db) test suite. Go to that repo to find the relevant tests. Likewise, if any do not exist that should, add them there!
+
+### Build
+
+The build script will build the distribution file for browsers.
+
+```sh
+$ npm run build
+```
+
+### Linting
+
+Please use [`standard`](https://standardjs.com). To check,
+
+
+```sh
+$ npm run lint
+```
+
+## Contribute
+
+Please, feel free to contribute! Take a look at [the issues](https://github.com/orbitdb/orbit-db-keystore/issues), and comment on an existing issue or create a new one if you have questions, bugs, or suggestions. For larger PRs, open an issue first if you could - drive-by PRs are also welcomed.
+
+Please abide by the [Code of Conduct](CODE_OF_CONDUCT.md). For more on contributing to OrbitDB, check out the docs in [orbitdb/welcome](https://github.com/orbitdb/welcome).
+
+
 ## License
 
 [MIT](LICENSE) © 2017-2018 Haja Networks Oy