phoneify/README.md

A simple tool that can parse inputs to a proper, readable "phone" type format.

# Phoneify
A very simple module that can parse an input to a readble, clean format for phone numbers.

## Installation
Through [npm](https://www.npmjs.com/package/phoneify):
```bash
$ npm install phoneify
```

## API Documentation:
There's only one function implemented:
```js
var phoneify = require('phoneify'); // phoneify is a function that takes one parameter
var input = 12345678901;
console.log(phoneify(input)); // parameter will be the number
```
You can choose to either include the leading "1" at the beginning of the phone number or leave it. But the length, initially, should be either 10 or 11 characters long.

Example output (will always return an object):
```json
{
    "original": "12345678901",
    "removeInitialNumber": "2345678901",
    "withPlus": "+12345678901",
    "countryCodeIntact": {
        "addParentheses": "1 (234) 567 8901",
        "addDashes": "1-234-567-8901",
        "addParenthesesWithDashes": "1-(234)-567-8901",
        "addDots": "1.234.567.8901",
        "addSlashes": "1/234/567/8901",
        "addTrailingSlashes": "1 (234) 567-8901"
        },
    "countryCodeRemoved": {
        "addParentheses": "(234) 567 8901",
        "addDashes": "234-567-8901",
        "addParenthesesWithDashes": "(234)-567-8901",
        "addDots": "234.567.8901",
        "addSlashes": "234/567/8901",
        "addTrailingSlashes": "(234) 567-8901"
        }
}
```

To access a specific format:
```js
var phoneify = require('phoneify');
var input = 12345678901;
format = phoneify(input);
console.log(format.withPlus);
console.log(format.countryCodeRemoved.addParenthesesWithDashes);
```
Output:
```
+12345678901
(234)-567-8901
```
## License
MIT.