readme-filename

Get a project readme file name.

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

Package Rankings

Top 6.67% on Npmjs.org

Badges

Extracted from project README

Related Projects

parse-git-config

Parse `.git/config` into a JavaScript object. sync or async.

25 Feb 2015 61

project-name

Get the name of a project from package.json, git config, or basename of the current working direc...

20 Oct 2015 12

generator-library

Scaffold a generic node library.

03 Jul 2016 1

git-branch

Get the current branch for a local git repository

04 Apr 2014 91

enable-travis

Enable Travis CI for a project from the command line.

28 Feb 2015 16

git-user-name

Get the name of the current user from git config, at the project or global scope, depending on wh...

04 Apr 2014 22

yarn-config-directory

Get the absolute path to the global yarn config directory.

21 Mar 2018 6

package-json-to-readme

Generate README.md from package.json contents

21 May 2014 384

global-modules

Returns the directory used by NPM for globally installed NPM packages.

06 Mar 2015 35

delete

Delete files and folders and any intermediate directories if they exist (sync and async).

28 Jun 2014 24

generator-standard-readme

Scaffold out a Standard Readme

13 May 2016 202

node-es6-starter

babel, code climate, commitizen, coveralls, easystatic, ghooks, istanbul, jasmine, rollup, travis...

21 Jul 2016 4

generator-dotfiles

Create a project dotfiles.

06 Jul 2016 0

readme-to-man-page

Convert package readme to a man page

14 Jul 2015 4

parse-gitignore

Parse a gitignore file into an array of patterns. Comments and empty lines are stripped.

27 Feb 2015 64