Namespace, Primitive, Method

npm

Need private packages and team management tools?Check out npm Orgs. »

packagereadme

1.0.0 • Public • Published

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
});
 

install

npm i packagereadme

Downloadsweekly downloads

1

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability