https://github.com/ngryman/readme-filename

Get a project readme file name.
https://github.com/ngryman/readme-filename

Last synced: 21 days ago
JSON representation

Get a project readme file name.

• Host: GitHub
• URL: https://github.com/ngryman/readme-filename
• Owner: ngryman
• License: mit
• Created: 2016-07-21T11:36:02.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-11-06T20:21:36.000Z (almost 5 years ago)
• Last Synced: 2024-09-21T06:14:38.517Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 16.6 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# readme-filename

> Get a project readme file name.

[![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url]

[travis-image]: https://img.shields.io/travis/ngryman/readme-filename.svg?style=flat

[travis-url]: https://travis-ci.org/ngryman/readme-filename

[codecov-image]: https://img.shields.io/codecov/c/github/ngryman/readme-filename.svg

[codecov-url]: https://codecov.io/github/ngryman/readme-filename

## Install

```bash

npm install --save readme-filename

```

## Usage

```javascript

const readmeFilename = require('readme-filename')

readmeFilename().then(console.log)

// => readme.md

readmeFilename('some/path').then(console.log)

// => README.markdown

```

## License

MIT © [Nicolas Gryman](http://ngryman.sh)