<commit_before>readme-md
=========
[![npm Version][NPM VERSION BADGE]][NPM PAGE]
[![Node.js][NODE VERSION BADGE]][NODE PAGE]
[![GitHub License][LICENSE BADGE]][LICENSE PAGE]
[![Build Status][BUILD BADGE]][BUILD PAGE]

A `README.md` generator.

Install
-------
```sh
$ npm install --save readme-md
```

Usage
-----
````js
const readme = require('readme-md');

const pkg = {name: 'my-awesome-package'};
const usage = `\`\`\`js
    require('my-awesome-package')({awesome: 'parameters'});
    \`\`\``;

readme({pkg, usage});
// > my-awesome-package
// > ==================
// > _To be documented._
// >
// > Install
// > -------
// > ```sh
// > $ npm install --save my-awesome-package
// > ```<commit_msg>Cleanup "usage" code syntax.<commit_after>readme-md
=========
[![npm Version][NPM VERSION BADGE]][NPM PAGE]
[![Node.js][NODE VERSION BADGE]][NODE PAGE]
[![GitHub License][LICENSE BADGE]][LICENSE PAGE]
[![Build Status][BUILD BADGE]][BUILD PAGE]

A `README.md` generator.

Install
-------
```sh
$ npm install --save readme-md
```

Usage
-----
````js
const readme = require('readme-md');

const pkg = {name: 'my-awesome-package'};
const usage = `
    \`\`\`js
    require('my-awesome-package')({awesome: 'parameters'});
    \`\`\`
`.trim();

readme({pkg, usage});
// > my-awesome-package
// > ==================
// > _To be documented._
// >
// > Install
// > -------
// > ```sh
// > $ npm install --save my-awesome-package
// > ```
{'fraction_non_alphanumeric': 0.2811188811188811, 'fraction_numerical': 0.0, 'mean_word_length': 3.3628048780487805, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 21, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1476107', 'n_tokens_mistral': 544, 'n_tokens_neox': 531, 'n_words': 110}