Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 2.04 KB

example-README.md

File metadata and controls

41 lines (25 loc) · 2.04 KB

Gitter Matrix [![npm version](https://badge.fury.io/js/.svg)](https://www.npmjs.com/package/) [![node](https://img.shields.io/node/v/.svg)](https://www.npmjs.com/package/)

Description

Install

This project uses npm and nodejs.

npm i <Replace Title>

Usage

// Fill out with actual use case
let <Replace Title> = require('<Replace Title>')
<Replace Title>.useMe()

Contribute

We would be happy to accept PRs! If you want to work on something, it'd be good to talk beforehand to make sure nobody else is working on it. You can reach us on Gitter, or in the [issues section](https://github.com/orbitdb//issues).

We also have regular community calls, which we announce in the issues in the @orbitdb welcome repository. Join us!

If you want to code but don't know where to start, check out the issues labelled ["help wanted"](https://github.com/orbitdb//issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+sort%3Areactions-%2B1-desc).

For specific guidelines for contributing to this repository, check out the Contributing guide. For more on contributing to OrbitDB in general, take a look at the @OrbitDB welcome repository. Please note that all interactions in @OrbitDB fall under our Code of Conduct.

License

MIT © 2019 Haja Networks Oy