Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

readme-filename

ngryman929MIT1.0.0TypeScript support: definitely-typed

Get a project readme file name

readme

readme-filename

Get a project readme file name.

travis codecov

Install

npm install --save readme-filename

Usage

const readmeFilename = require('readme-filename')

readmeFilename().then(console.log)
// => readme.md

readmeFilename('some/path').then(console.log)
// => README.markdown

License

MIT © Nicolas Gryman