deromanize/README.md

Convert roman numerals to arabic numbers (useful for books, outlines, documentation, slide decks, etc)

# deromanize [![NPM version](https://img.shields.io/npm/v/deromanize.svg?style=flat)](https://www.npmjs.com/package/deromanize) [![NPM monthly downloads](https://img.shields.io/npm/dm/deromanize.svg?style=flat)](https://npmjs.org/package/deromanize)  [![NPM total downloads](https://img.shields.io/npm/dt/deromanize.svg?style=flat)](https://npmjs.org/package/deromanize) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/deromanize.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/deromanize)

> Convert roman numerals to arabic numbers (useful for books, outlines, documentation, slide decks, etc)

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save deromanize
```

Install with [yarn](https://yarnpkg.com):

```sh
$ yarn add deromanize
```

## Usage

```js
var deromanize = require('deromanize');
console.log(deromanize('LVIII'));
//=> 58
```

## Attribution

Inspired by this [blog post](http://blog.stevenlevithan.com/archives/javascript-roman-numeral-converter) by [Steven Levithan](https://github.com/slevithan).

## About

### Related projects

* [repeat-string](https://www.npmjs.com/package/repeat-string): Repeat the given string n times. Fastest implementation for repeating a string. | [homepage](https://github.com/jonschlinkert/repeat-string "Repeat the given string n times. Fastest implementation for repeating a string.")
* [romanize](https://www.npmjs.com/package/romanize): Convert arabic numbers to roman numerals (useful for books, outlines, documentation, slide decks, etc) | [homepage](https://github.com/jonschlinkert/romanize "Convert arabic numbers to roman numerals (useful for books, outlines, documentation, slide decks, etc)")
* [to-regex-range](https://www.npmjs.com/package/to-regex-range): Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than… [more](https://github.com/jonschlinkert/to-regex-range) | [homepage](https://github.com/jonschlinkert/to-regex-range "Pass two numbers, get a regex-compatible source string for matching ranges. Validated against more than 2.87 million test assertions.")

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### Building docs

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

### Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

```sh
$ npm install && npm test
```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)

### License

Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 23, 2017._