Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/martinandert/pubs

Publish and subscribe.
https://github.com/martinandert/pubs

browser nodejs publish-subscribe pubsub

Last synced: 1 day ago
JSON representation

Publish and subscribe.

Awesome Lists containing this project

README

        

# pubs

[![Travis build status](https://img.shields.io/travis/martinandert/pubs/master.svg)](https://travis-ci.org/martinandert/pubs)
[![no dependencies](https://img.shields.io/badge/dependencies-none-brightgreen.svg)](https://npmjs.com/package/pubs)
[![license](https://img.shields.io/github/license/martinandert/pubs.svg)](https://github.com/martinandert/pubs/blob/master/LICENSE.txt)
![TypeScript typings](https://img.shields.io/badge/types-TypeScript-blue.svg)

TODO: add intro

## Installation

Install via npm:

```bash
% npm install pubs
```

Or via yarn:

```bash
% yarn add pubs
```

The UMD build is also available on [unpkg](https://unpkg.com/), adding a `pubs` object to the global scope.

```html

```

## 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.