extract-description

Get the description from a README. Basically the first non-heading paragraph.

Install with npm

npm i extract-description --save

Usage

var extract = require('extract-description');

var fs = require('fs');
var str = fs.readFileSync('README.md', 'utf8');

extract(str);
//=> Get the description from a README. Basically the first non-heading paragraph.

Run tests

Install dev dependencies:

node i -d && mocha

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert
Released under the MIT license

---

This file was generated by verb on December 30, 2014.