us-street-abbreviations/README.md

Substitutes full words in U.S. street addresses with their postal short code abbreviations.

# US Street Abbreviations
## Turns a US street address into a unique set of strings with various standard US postal street keywords abbreviated.

## Installation:

```bash
npm install --save us-street-abbrevations
```

## Usage:

```javascript
const X = import * from 'us-street-abbreviations';
X.getVariants('123 North Northeast Street');
```

Set DEBUG environment variable to true to enable debugging messages.

## Expected result:

```javascript
{
  '123 north northeast street',
  '123 n northeast street',
  '123 n ne street',
  '123 n ne st',
  '123 north ne street',
  '123 north ne st',
  '123 north northeast st',
}
```

TODO:

  * Allow for expansions (exchange w/arrays swapped)
  * Write tests