0.0.3 • Published 9 years ago

has-readme

Licence

MIT

Version

0.0.3

Deps

Vulns

Weekly

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.

$ npm install --save has-readme

.
├── project-zero
│   └── package.json
└── project-one
    ├── package.json
    └── readme.md

import hasReadme from 'has-readme'

hasReadme('project-zero')
//=> false

hasReadme('project-one')
//=> true

Returns a boolean.

Type: string
Default: process.cwd()

Current working directory.

Keywords