0.0.3 • Published 7 years ago
has-readme v0.0.3
has-readme
Check if a project has README.md
Useful for tools that needs to know whether to write on README.md or create a new one.
Checks if a README.md file is present in the working directory.
Install
$ npm install --save has-readme
Usage
.
├── project-zero
│ └── package.json
└── project-one
├── package.json
└── readme.md
import hasReadme from 'has-readme'
hasReadme('project-zero')
//=> false
hasReadme('project-one')
//=> true
API
hasReadme(cwd)
Returns a boolean
.
cwd
Type: string
Default: process.cwd()
Current working directory.
License
MIT © Bu Kinoshita