| 1 | # uzh-summary-of-credits [](https://travis-ci.org/JonnyBurger/uzh-summary-of-credits)
|
| 2 |
|
| 3 | > My incredible module
|
| 4 |
|
| 5 |
|
| 6 | ## Install
|
| 7 |
|
| 8 | ```
|
| 9 | $ npm install --save uzh-summary-of-credits
|
| 10 | ```
|
| 11 |
|
| 12 |
|
| 13 | ## Usage
|
| 14 |
|
| 15 | ```js
|
| 16 | const uzhSummaryOfCredits = require('uzh-summary-of-credits');
|
| 17 |
|
| 18 | uzhSummaryOfCredits('unicorns');
|
| 19 | //=> 'unicorns & rainbows'
|
| 20 | ```
|
| 21 |
|
| 22 |
|
| 23 | ## API
|
| 24 |
|
| 25 | ### uzhSummaryOfCredits(input, [options])
|
| 26 |
|
| 27 | #### input
|
| 28 |
|
| 29 | Type: `string`
|
| 30 |
|
| 31 | Lorem ipsum.
|
| 32 |
|
| 33 | #### options
|
| 34 |
|
| 35 | ##### foo
|
| 36 |
|
| 37 | Type: `boolean`<br>
|
| 38 | Default: `false`
|
| 39 |
|
| 40 | Lorem ipsum.
|
| 41 |
|
| 42 |
|
| 43 | ## License
|
| 44 |
|
| 45 | MIT © [Jonny Burger](http://jonny.io)
|