feathers-blipp/README.md

feathers blipp

# feathers-blipp
FeathersJS plugin that displays the all of the routes/services similar to [`blipp`](https://github.com/danielb2/blipp) for [`Hapi`](https://github.com/hapijs/hapi).

## Installation

```
npm install feathers-blipp --save
```

## Usage

`feathers-blipp` MUST be configured AFTER services.

```js
  const blipp = require('feathers-blipp');
  app
    .configure(middleware)
    .configure(services)
    .configure(blipp); // <<-- MUST be configured AFTER services
```

An `options` object with `verbose` boolean can also be passed as an argument.

```js
  const blipp = require('feathers-blipp');
  app
    .configure(middleware)
    .configure(services)
    .configure(blipp({ verbose: true }));
```

## Screenshots
### Verbose
![Alt text](screenshots/verbose.JPG?raw=true "Verbose routes table")

### Not Verbose
![Alt text](screenshots/not-verbose.JPG?raw=true "Not Verbose routes table")

## Complete Example

```
git clone git@github.com:bsubedi26/feathers-blipp.git
cd /feathers-blipp/example
npm install
npm start
```

## License

Copyright (c) 2017

Licensed under the [MIT license](LICENSE).