github-readme

Fetch README from GitHub.

Example

> githubReadme('git', 'git', function (err, readme) {
>   console.log(readme.slice(0, 300));
> })
////////////////////////////////////////////////////////////////

	Git - the stupid content tracker

////////////////////////////////////////////////////////////////

"git" can mean anything, depending on your mood.

 - random three-letter combination that is pronounceable, and not
   actually used

API

githubReadme(user, repo, cb(err, readme))

Fetches README from GitHub and returns it as a string. The filename is detected automatically.

Related

• github-man — open README from GitHub repository as a man page.

Install

npm install github-readme

License

MIT