~reesmichael1/elvish-completions

7bef10f9238f98d4218e3a4440a546f94f75de7a — Michael Rees 11 months ago 0493f58
Add epm installation instructions in README
1 files changed, 25 insertions(+), 4 deletions(-)

M README.md
M README.md => README.md +25 -4
@@ 2,12 2,33 @@

A collection of completion modules for [the Elvish shell](https://elv.sh).

## pass.elv
## Installation Instructions

This module provides completions for [`pass`](https://passwordstore.org).
If you have not already configured [`epm`](https://elv.sh/ref/epm.html) to recognize packages from `sr.ht`, you will need to do so:

Currently, it only provides completions for the filenames stored within the password directory (i.e., it does not know about `pass` specific commands like `insert`, `edit`, etc.). It depends on `tree`, although I'll probably eventually rewrite it in pure Elvish.
```
mkdir .elvish/lib/git.sr.ht
echo '{
  "method": "git",
  "protocol": "http",
  "levels": "2"
}' > .elvish/lib/git.sr.ht/epm-domain.cfg
```

Once `epm` has been properly configured, you should be able to use it to install this module.

```
epm:install git.sr.ht/~reesmichael1/elvish-completions
```

## Provided Modules

###  pass.elv

```
use sr.ht/reesmichael1/elvish-completions/pass
use git.sr.ht/~reesmichael1/elvish-completions/pass
```

This module provides completions for [`pass`](https://passwordstore.org).

Currently, it only provides completions for the filenames stored within the password directory (i.e., it does not know about `pass` specific commands like `insert`, `edit`, etc.). It depends on `tree`, although I'll probably eventually rewrite it in pure Elvish.