<commit_before># paper-rulings

[![Build Status][travis-image]][travis-url]
[![Coverage][coveralls-image]][coveralls-url]

Measurements and information about paper rulings

## Installation

```
npm install --save paper-rulings
```

## Usage

```javascript
const paperRulings = require('paper-rulings')

console.log(JSON.stringify(paperRulings('gregg', { format: 'decimal' }), null, 2))
```

### Output

```
{
  "names": [
    "Gregg"
  ],
  "spacing": "0.34375 in",
  "margins": [
    {
      "left": "50%"
    }
  ],
  "notes": "Used for stenography. Includes a single margin down the center of the page."
}
```

## API

### `paperRulings(rulingName, options)`

#### `rulingName`

Type: `string`

One of the following:

- Narrow
- Medium
- College
- Wide
- Legal
- Gregg
- Pitman

#### `options`

Type: `object`

##### `options.format`

Allows you to specify the output values formats

Type: `string`

One of the following:

- fraction
- decimal

## Resources

- https://en.wikipedia.org/wiki/Ruled_paper

## License

MIT © [<NAME>](https://github.com/fdesjardins)

[travis-url]: https://travis-ci.org/fdesjardins/paper-rulings
[travis-image]: https://img.shields.io/travis/fdesjardins/paper-rulings.svg?style=flat
[coveralls-url]: https://coveralls.io/r/fdesjardins/paper-rulings
[coveralls-image]: https://img.shields.io/coveralls/fdesjardins/paper-rulings.svg?style=flat<commit_msg>add npm badge to readme<commit_after># paper-rulings

[![Build Status][travis-image]][travis-url]
[![NPM Version][npm-image]][npm-url]
[![Coverage][coveralls-image]][coveralls-url]

Measurements and information about paper rulings

## Installation

```
npm install --save paper-rulings
```

## Usage

```javascript
const paperRulings = require('paper-rulings')

console.log(JSON.stringify(paperRulings('gregg', { format: 'decimal' }), null, 2))
```

### Output

```
{
  "names": [
    "Gregg"
  ],
  "spacing": "0.34375 in",
  "margins": [
    {
      "left": "50%"
    }
  ],
  "notes": "Used for stenography. Includes a single margin down the center of the page."
}
```

## API

### `paperRulings(rulingName, options)`

#### `rulingName`

Type: `string`

One of the following:

- Narrow
- Medium
- College
- Wide
- Legal
- Gregg
- Pitman

#### `options`

Type: `object`

##### `options.format`

Allows you to specify the output values formats

Type: `string`

One of the following:

- fraction
- decimal

## Resources

- https://en.wikipedia.org/wiki/Ruled_paper

## License

MIT © [<NAME>](https://github.com/fdesjardins)

[npm-url]: https://www.npmjs.com/package/paper-rulings
[npm-image]: https://img.shields.io/npm/v/paper-rulings.svg?style=flat
[travis-url]: https://travis-ci.org/fdesjardins/paper-rulings
[travis-image]: https://img.shields.io/travis/fdesjardins/paper-rulings.svg?style=flat
[coveralls-url]: https://coveralls.io/r/fdesjardins/paper-rulings
[coveralls-image]: https://img.shields.io/coveralls/fdesjardins/paper-rulings.svg?style=flat
{'fraction_non_alphanumeric': 0.18098471986417658, 'fraction_numerical': 0.006112054329371817, 'mean_word_length': 4.289048473967684, 'pattern_counts': {'":': 10, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 14, 'lorem ipsum': 0, 'www.': 1, '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': '5651208', 'n_tokens_mistral': 1167, 'n_tokens_neox': 1112, 'n_words': 209}