ngryman / get-readme

Retrieve the readme contents from a directory

get-readme

Retrieve the readme contents from a directory. This is able to retrieve any common readme name.

Installation

npm install --save get-readme

Usage

var getReadme = require('get-readme')

getReadme('.')
getReadme('some/other/path')

License

MIT

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. Create new Pull Request

Crafted with <3 by John Otander (@4lpine).

---

This package was initially generated with yeoman and the p generator.