martinandert / pubs

Publish and subscribe.

pubs

TODO: add intro

Installation

Install via npm:

% npm install pubs

Or via yarn:

% yarn add pubs

The UMD build is also available on unpkg, adding a pubs object to the global scope.

<script src="https://unpkg.com/pubs/dist/umd.min.js"></script>

Usage

TODO: add usage docs and API reference

Contributing

Here's a quick guide:

1. Fork the repo and yarn install.
2. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate: yarn test.
3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or are fixing a bug, we need a test!
4. Make the test pass.
5. Push to your fork and submit a pull request.

Licence

Released under The MIT License.