1.4.0 • Published 4 years ago
get-package-readme v1.4.0
get-package-readme
Get the GitHub readme for an npm package
install
npm install get-package-readme
usage
var getPackageReadme = require('get-package-readme')
getPackageReadme('webtorrent', function (err, readme) {
if (err) throw err
console.log(readme)
})
why this instead of readme-getter
?
get-package-readme
(this package) gets an npm packages' GitHub readme (from the master
branch) and falls back to the npm readme if it exists. If you want just the npm readme, you should use readme-getter
.
license
MIT. Copyright (c) Feross Aboukhadijeh.