❤
npm
Sign UpSign In

readme-filename
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/readme-filename package

1.0.0 • Public • Published

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

Readme

Keywords

none

Package Sidebar

Install

npm i readme-filename

Repository

github.com/ngryman/readme-filename

Homepage

github.com/ngryman/readme-filename#readme

Weekly Downloads

765

Version

1.0.0

License

MIT

Last publish

Collaborators

  • ngryman
Try on RunKit
Report malware