readme.md
v0.1.1
Published
Allow creating a simple JS String from a README.md in order to use it in various package config files (like package.json)
Downloads
97
Maintainers
Readme
readme.md
readme.md is an application that allows easy updating of package.json files with the content from the README.md. Installation
In order to install it you can run:
$ npm install -g readme.md
Usage
Then in the project that you develop you can run again:
$ readme-md-update
This will update your package.json file, setting the readme contents to the JSON escaped file. Programmatic Access
In case you want to update a different file, or read a different file, or use a different property, you can also use it directly:
var readme = require("readme.md");
readme.writeFileIntoJson("README.md", "package.json", "readme");