Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mhyfritz/ashram
acronym search program
https://github.com/mhyfritz/ashram
acronym cli javascript nodejs words
Last synced: about 2 months ago
JSON representation
acronym search program
- Host: GitHub
- URL: https://github.com/mhyfritz/ashram
- Owner: mhyfritz
- License: mit
- Created: 2017-03-20T20:44:15.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-05T07:04:26.000Z (about 7 years ago)
- Last Synced: 2024-11-17T09:44:58.850Z (about 2 months ago)
- Topics: acronym, cli, javascript, nodejs, words
- Language: JavaScript
- Homepage: http://mhyfritz.com/ashram
- Size: 4.88 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# ashram: acronym search program
## Installation
```bash
yarn global add ashram
```
or
```bash
npm install -g ashram
```
## Usage
```bash
ashram --phrase 'acronym search program'
...
aero
...
anchor
...
ashram
...
```
By default, acronyms are searched against [`word-list`](https://github.com/sindresorhus/word-list),
but you can also use your own file:
```bash
ashram --file --phrase ...
```
## Explanation
Given a phrase, `ashram` searches a list of words for acronyms of that phrase.
The acronyms have following constraints:
* the first letter of phrase and acronym have to match
* for every word in the phrase at least one character has to match in the acronym