rm

readme.md

Allow creating a simple JS String from a README.md in order to use it in various package config files (like package.json)

Showing:

Popularity

Downloads/wk

2

GitHub Stars

0

Maintenance

Last Commit

7yrs ago

Contributors

0

Package

Dependencies

1

Size (min+gzip)

3.7KB

License

Type Definitions

Tree-Shakeable

No?

Categories

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial