docs: update
This commit is contained in:
parent
92501d9f64
commit
7073860a6d
28
README.md
28
README.md
|
@ -2,11 +2,39 @@
|
||||||
|
|
||||||
A simple password manager using GPG.
|
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
|
## TODO
|
||||||
|
|
||||||
- [x] Add support for not generating passwords.
|
- [x] Add support for not generating passwords.
|
||||||
- [x] Add support for categories.
|
- [x] Add support for categories.
|
||||||
- [ ] Add an optional `tree` view.
|
- [ ] Add an optional `tree` view.
|
||||||
|
- [ ] Add support for both `gpg` and `gpg2`.
|
||||||
- [ ] Man page.
|
- [ ] Man page.
|
||||||
- [ ] Setup automatic linting.
|
- [ ] Setup automatic linting.
|
||||||
- [ ] Documentation.
|
- [ ] Documentation.
|
||||||
|
|
Loading…
Reference in New Issue