0.2.0 • Published 8 years ago
readme-file v0.2.0
readme-file
Get the name of README file in a directory.
Example
var readmeFile = require('readme-file');
readmeFile('.')
//=> "/path/to/README.md"
try {
readmeFile('/tmp')
}
catch (err) {
err.message
//=> "README file not found in /tmp"
}
API
readmeFile(dir)
Returns the path to README file in the directory or throws an error.
Install
npm install readme-file
License
MIT