mu-router/README.md

The official pattern router for mu

# mu-router

The official pattern router for mu

[![npm][npm-badge]][npm-url]
[![travis][travis-badge]][travis-url]
[![coveralls][coveralls-badge]][coveralls-url]
[![david][david-badge]][david-url]

- __Sponsor:__ [nearForm][sponsor]
- __Status:__ Experimental

Part of the Official [mu][Mu Suite].

`mu-router` is the pattern router for [mu][`mu`], used internally by [mu][`mu`] core it manages a routing table based on Bloom filters.


* [Install](#install)
* [API](#api)
* [License](#license)


## Install

```sh
$ npm install mu-router
```

## API
To do..

## License
Copyright Peter Elger 2016 & Contributors, Licensed under [MIT][].


[mu]: https://github.com/apparatus/mu
[travis-badge]: https://travis-ci.org/apparatus/mu.svg?branch=master
[travis-url]: https://travis-ci.org/apparatus/mu
[npm-badge]: https://badge.fury.io/js/mu.svg
[npm-url]: https://npmjs.org/package/mu
[logo-url]: https://raw.githubusercontent.com/apparatus/mu/master/assets/mu.png
[coveralls-badge]: https://coveralls.io/repos/apparatus/mu/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/apparatus/mu?branch=master
[david-badge]: https://david-dm.org/apparatus/mu.svg
[david-url]: https://david-dm.org/apparatus/mu?path=packages/mu-router
[sponsor]: http://nearform.com
[MIT]: ./LICENSE