提取描述工具使用指南

提取描述是一款可以从自述文件中提取描述的工具。基本方法是提取第一个非标题段落。

安装：

使用以下命令安装工具：

npm i extract-description --save

用法：

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

var fs = require('fs');

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

extract(str); //=> 获取README文件的描述。

运行测试：

安装开发依赖：

node i -d && mocha

贡献：

拉取请求和点赞都是非常欢迎的。如果有错误或功能请求，可以联系作者乔恩·施林克特。

许可证：

版权所有(c) 2014。