@trust/pouch-crypto

PouchCrypto

PouchDB Storage for JSON Web Documents

Ipsum iste numquam velit hic corrupti! Temporibus repellendus voluptate nobis fuga voluptate ab quae. Autem tempore suscipit earum suscipit molestiae placeat. Vitae fugiat sint obcaecati nulla illum libero. Placeat officia!

Table of Contents

• Security
• Install
• Usage
• Develop
• API
• Contribute
• MIT License

Security

TBD

Install

$ npm install @trust/pouch-crypto --save

Usage

Node.js

const PouchCrypto = require('@trust/pouch-crypto')

API

Contribute

Issues

• please file issues :)
• for bug reports, include relevant details such as platform, version, relevant data, and stack traces
• be sure to check for existing issues before opening new ones
• read the documentation before asking questions
• it's strongly recommended to open an issue before hacking and submitting a PR
• we reserve the right to close an issue for excessive bikeshedding

Pull requests

Policy

• we're not presently accepting unsolicited pull requests
• create an issue to discuss proposed features before submitting a pull request
• create an issue to propose changes of code style or introduce new tooling
• ensure your work is harmonious with the overall direction of the project
• ensure your work does not duplicate existing effort
• keep the scope compact; avoid PRs with more than one feature or fix
• code review with maintainers is required before any merging of pull requests
• new code must respect the style guide and overall architecture of the project
• be prepared to defend your work

Style guide

• ES6
• Standard JavaScript
• jsdocs

Code reviews

• required before merging PRs
• reviewers SHOULD run the code under review

Collaborating

Weekly project meeting

• Thursdays from 1:00 PM to 2:00 Eastern US time at [TBD]
• Join remotely with Google Hangouts

Pair programming

• Required for new contributors
• Work directly with one or more members of the core development team

Code of conduct

• @trust/pouch-crypto follows the Contributor Covenant Code of Conduct.

Contributors

• Christian Smith @christiansmith
• Greg Linklater @EternalDeiwos
• Dmitri Zagidulin @dmitrizagidulin
• Cornel Stefanache @cstefanache

MIT License

Copyright (c) 2017 Anvil Research, Inc.