sao-nm
Version:
Scaffolding out a node module.
38 lines (24 loc) • 1.75 kB
Markdown
<% const camelcasedName = this.camelcase(name) -%>
# <%= name %>
[](https://npmjs.com/package/<%= name %>) [](https://npmjs.com/package/<%= name %>) [](https://circleci.com/gh/<%= username %>/<%= name %>/tree/master) <% if (coverage) { %> [](https://codecov.io/gh/<%= username %>/<%= name %>)
<% } %><% if (username === 'egoist') { %> [](https://patreon.com/egoist) [](https://chat.egoist.moe)<% } %>
## Install
```bash
<% if (context.npmClient === 'yarn') { %>yarn add<% } else { %>npm i<% } %> <%= name %>
```
## Usage
```js
const <%= camelcasedName %> = require('<%= name %>')
<%= camelcasedName %>()
//=> foo
```
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Author
**<%= name %>** © [<%= author %>](https://github.com/<%= username %>), Released under the [MIT](./LICENSE) License.<br>
Authored and maintained by <%= author %> with help from contributors ([list](https://github.com/<%= username %>/<%= name %>/contributors)).
> [<%= website.replace(/^https?:\/\//, '') %>](<%= website %>) · GitHub [@<%= author %>](https://github.com/<%= username%>)<% if (twitter) { %> · Twitter [@<%= twitter %>](https://twitter.com/<%= twitter %>)<% } %>