docs: update

This commit is contained in:
Dylan Araps 2019-02-25 00:04:26 +02:00
parent 92501d9f64
commit 7073860a6d
1 changed files with 28 additions and 0 deletions

View File

@ -2,11 +2,39 @@
A simple password manager using GPG.
## Dependencies
- `bash`
- `gpg2`
## Usage
Examples:
- `pash add web/gmail`,
- `pash list`,
- `pash del google`,
- `pash show github`.
```
pash - simple password manager.
usage: pash [add|del|show|list] [name] [-n,-q,-c] [-l length]
-n Limit passwords to alphanumeric characters.
-l length Length of generated passwords.
-c Copy password to clipboard.
-q Don't print password to stdout.
-h Print this message.
-v Show version.
```
## TODO
- [x] Add support for not generating passwords.
- [x] Add support for categories.
- [ ] Add an optional `tree` view.
- [ ] Add support for both `gpg` and `gpg2`.
- [ ] Man page.
- [ ] Setup automatic linting.
- [ ] Documentation.