From 7073860a6d01b869d54d51e7b4c11b28f7acaa3d Mon Sep 17 00:00:00 2001 From: Dylan Araps Date: Mon, 25 Feb 2019 00:04:26 +0200 Subject: [PATCH] docs: update --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 4332089..bc563d7 100644 --- a/README.md +++ b/README.md @@ -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.