generator-njsm
Version:
Scaffold out a node module
66 lines (39 loc) • 1.1 kB
Markdown
<%= repoName %> [](https://travis-ci.com/<%= githubUsername %>/<%= repoName %>)<% if (codecov) { %> [](https://codecov.io/gh/<%= githubUsername %>/<%= repoName %>?branch=master)<% } %>
<%= moduleDescription %>
# Install
```
npm install <%= moduleName %>
```
# Usage
```js
const <%= camelModuleName %> = require('<%= moduleName %>');
<%= camelModuleName %>('unicorns');
//=> 'unicorns & rainbows'
```
# API
## <%= camelModuleName %>(input, options?)
### input
Type: `string`
Lorem ipsum.
### options
Type: `object`
#### foo
Type: `boolean`\
Default: `false`
Lorem ipsum.<% if (cli) { %>
# CLI
```
npm install --global <%= moduleName %>
```
```
<%= repoName %> --help
Usage
<%= repoName %> [input]
Options
--foo Lorem ipsum [Default: false]
Examples
$ <%= repoName %>
unicorns & rainbows
$ <%= repoName %> ponies
ponies & rainbows
```<% } %>