<commit_before>README
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependencies][dependencies-image]][dependencies-url]

> Creates a `README.md` file.


## Installation

``` bash
$ npm install @kgryte/readme
```


## Usage

``` javascript
var cp = require( '@kgryte/readme' );
```

#### cp( dest[, opts ][, clbk ] )

Asynchronously create a `README.md` file in a specified `destination` directory.

``` javascript
cp( 'path/to/a/directory', onCreate );

function onCreate( error ) {
	if ( error ) {
		throw error;
	}
	console.log( 'Success!' );
}
```

The function accepts the following `options`:
*	__template__: `README.md` template name. Default: `'node_module'`.
*	__title__: title. Default: `''`.
*	__desc__: description. Default: `''`.
*	__repo__: Github repository.
*	__license__: license. Default: `'[MIT](http://opensource.org/licenses/MIT)'`.
*	__holder__: copyright holder.

By default, a `node_module` template is used. To specify a different `README.md` template, set the `template` option.

``` javascript
cp( 'path/to/a/directory', {
	'template': 'node_module'
});
```

To specify `README.md` fields, set the corresponding `options`.

``` javascript
cp( 'path/to/a/directory', {
	'title': 'beep',
	'holder': '<NAME>',
	'repo': 'janedoe/beep'
});
```

<commit_msg>[FIX] embedded link.<commit_after>README
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependencies][dependencies-image]][dependencies-url]

> Creates a `README.md` file.


## Installation

``` bash
$ npm install @kgryte/readme
```


## Usage

``` javascript
var cp = require( '@kgryte/readme' );
```

#### cp( dest[, opts ][, clbk ] )

Asynchronously create a `README.md` file in a specified `destination` directory.

``` javascript
cp( 'path/to/a/directory', onCreate );

function onCreate( error ) {
	if ( error ) {
		throw error;
	}
	console.log( 'Success!' );
}
```

The function accepts the following `options`:
*	__template__: `README.md` template name. Default: `'node_module'`.
*	__title__: title. Default: `''`.
*	__desc__: description. Default: `''`.
*	__repo__: Github repository.
*	__license__: license. Default: [`'MIT'`](http://opensource.org/licenses/MIT)'`.
*	__holder__: copyright holder.

By default, a `node_module` template is used. To specify a different `README.md` template, set the `template` option.

``` javascript
cp( 'path/to/a/directory', {
	'template': 'node_module'
});
```

To specify `README.md` fields, set the corresponding `options`.

``` javascript
cp( 'path/to/a/directory', {
	'title': 'beep',
	'holder': '<NAME>',
	'repo': 'janedoe/beep'
});
```


{'fraction_non_alphanumeric': 0.1953437613677701, 'fraction_numerical': 0.0, 'mean_word_length': 4.901287553648069, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 7, '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': '6730550', 'n_tokens_mistral': 1024, 'n_tokens_neox': 957, 'n_words': 236}