Package Exports

github-readme

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-readme) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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.

Install

npm install github-readme

License

MIT