# ashram

> acronym search program

Latest version **1.0.0** (published 2017-11-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install ashram
pnpm add ashram
yarn add ashram
bun add ashram
```

Provides the command `ashram`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-11-05 |
| First published | 2017-03-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Markus Hsi-Yang Fritz |
| Maintainers | mhyfritz |

## Links

- npm: https://www.npmjs.com/package/ashram
- Repository: https://github.com/mhyfritz/ashram
- Issues: https://github.com/mhyfritz/ashram/issues
- npm.io page: https://npm.io/package/ashram

## Dependencies (3)

- [commander](https://npm.io/package/commander.md) ^2.11.0
- [word-list](https://npm.io/package/word-list.md) ^2.0.0
- [@mhyfritz/acronym](https://npm.io/package/@mhyfritz/acronym.md) ^0.3.0

## Recent versions

- 1.0.0 (latest) — 2017-11-05
- 0.2.1 — 2017-03-30
- 0.2.0 — 2017-03-21
- 0.1.0 — 2017-03-21

## 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 <words.txt> --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

---
_Source: https://npm.io/package/ashram · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._