return the readme as a string for the current package based on closest package.json in the specified or parent directory"
JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.travis.yml
README.md
index.js
package-lock.json
package.json

README.md

Build Status

packagereadme

return the readme as a string for the current package based on closest package.json in the specified or parent directory

example

var readme = require('packagereadme');

readme(__dirname,function(err,readme){
  console.log(readme);
  // prints the module's readme if found
});