acronym

Generate your very own acronyms!

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
acronym
001.0.06 years ago6 years agoMinified + gzip package size for acronym in KB

Readme

acronym
Build Status Test Coverage
Generate your very own acronyms!
Use it for generating version tags, committee designations, or even band names! Uses more-words.

Install

``` $ npm install --save acronym ```

Usage

Generate acronym from a string: ```js import acronym from 'acronym' acronym('npm') // => 'Nice Promise Mistakes' ``` Generate acronym from an array of strings: ```js import acronym from 'acronym' const words = 'wut', 'bird', 'noodle' ; acronym(words) // => 'Wins Unapproved Thrilled', // => 'Boring Irresistibile Raptures Disaster', // => 'Novel Oversell Outcry Devastated Lack Endorse' ```

Options

Pass in options via a second parameter to the acronym() function

capitalize

Determines wether the first letter of each word in the acronym will be capital. Default is true. ```js import acronym from 'acronym' const options = { capitalize: true } acronym('npm', options) // => 'No Pleasure Misbehaving' ``` ```js import acronym from 'acronym' const options = { capitalize: false } acronym('npm', options) // => 'no profiteer misreporting' ```

separator

Determines the string between each word in the acronyn. Default is a single space. ```js import acronym from 'acronym' const options = { separator: ', ' } acronym('npm', options) // => 'Nasty, Preventing, Mocked' ``` ```js import acronym from 'acronym' const options = { separator: '-', capitalize: false } acronym('npm', options) // => 'needy-positive-mercy' ```

License

MIT © Pat Lillis