# acronym
> Generate an acronym for a given string.
## Usage
```javascript
var acronym = require( '@stdlib/string/acronym' );
```
#### acronym( str\[, options] )
Generates an acronym for a given string.
```javascript
var out = acronym( 'the quick brown fox' );
// returns 'QBF'
out = acronym( 'Hard-boiled eggs' );
// returns 'HBE'
```
The function accepts the following `options`:
- **stopwords**: list of custom stop words. If not specified, the function uses a default set of stop words from the English language that were deemed words one would likely want to exclude from the acronym generation (a subset of the stop words from [@stdlib/datasets/stopwords-en][@stdlib/datasets/stopwords-en]).
By default, the function uses a list of common English stop words. To use a custom list, set the `stopwords` option.
```javascript
var out = acronym( 'the quick brown fox', {
'stopwords': []
});
// returns 'TQBF'
out = acronym( 'the quick brown fox', {
'stopwords': [ 'the', 'quick', 'brown', 'fox' ]
});
// returns ''
```
## Examples
```javascript
var acronym = require( '@stdlib/string/acronym' );
var str = 'Test-driven development';
var out = acronym( str );
// returns 'TDD'
str = 'Industrial Business Machines';
out = acronym( str );
// returns 'IBM'
str = 'National Aeronautics and Space Administration';
out = acronym( str );
// returns 'NASA'
str = 'To be determined...';
out = acronym( str, {
'stopwords': []
});
// returns 'TBD'
```
* * *
## CLI
### Usage
```text
Usage: acronym [options] []
Options:
-h, --help Print this message.
-V, --version Print the package version.
--stopwords str Comma-separated list of custom stop words.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
```
### Notes
- If the split separator is a [regular expression][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes.
```bash
# Not escaped...
$ echo -n $'quick brown fox\nAlpha-Centauri' | acronym --split /\r?\n/
# Escaped...
$ echo -n $'quick brown fox\nAlpha-Centauri' | acronym --split /\\r?\\n/
```
- The implementation ignores trailing delimiters.
### Examples
```bash
$ acronym 'the quick brown fox'
QBF
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n 'the quick brown fox'' | acronym
QBF
```
By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option.
```bash
$ echo -n 'quick brown fox\tAlpha-Centauri' | acronym --split '\t'
QBF
AC
```
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[@stdlib/datasets/stopwords-en]: https://www.npmjs.com/package/@stdlib/datasets-stopwords-en