PouchDB JSONDocument Model (@trust/model)

PouchDB adapter for the json-document modelling framework.

TODO: Fill out this long description.

Table of Contents

• Background
• Install
• Usage
• API
• Maintainers
• Contribute
• License

Background

Install

$ npm install @trust/model --save

Usage

const { DocumentModel, CryptoModel } = require('@trust/model')

DocumentModel and CryptoModel have equivalent functionality but extend different base classes. CryptoModel extends JWD from @trust/jose, which introduces various cryptographic functions. DocumentModel extends JSONDocument which JWD shares as a common ancestor. For more information please see @trust/jose and @trust/json-document.

Develop

Install

$ git clone [email protected]:EternalDeiwos/model.git
$ cd model
$ npm install

Test

$ npm test

Coverage

$ npm run coverage

API

Full documentation can be found here

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

• Conventional Changelog
• EditorConfig
• ES6
• Standard JavaScript
• jsdocs

Code reviews

• required before merging PRs
• reviewers MUST run and test the code under review

Collaborating

This project is part of a greater group of projects visible here at the @trust organisation on NPM.

Pair programming

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

Code of conduct

• @trust/model follows the Contributor Covenant Code of Conduct.

Maintainers

• @EternalDeiwos
• @christiansmith

License

MIT © 2017 Greg Linklater