Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
return the readme as a string for the current package based on closest package.json in the specified or parent directory"
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
test
.travis.yml
README.md
index.js
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
});
Something went wrong with that request. Please try again.