From 1c0e287dca747dd5539edfd5624da1e918d9a2cd Mon Sep 17 00:00:00 2001 From: Dylan Araps Date: Mon, 25 Feb 2019 08:48:54 +0200 Subject: [PATCH] docs: update --- README.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1553d47..dfbfa05 100644 --- a/README.md +++ b/README.md @@ -8,21 +8,35 @@ A simple password manager using GPG. - `bash` - `gpg2` +**Clipboard Support**: + +- `xclip` or `tmux` + ## 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] +SYNOPSIS --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. +pash [ add|del|show|list ] [name] [ -ncqhv ] [ -l length ] + +COMMANDS + +[a]dd [name]: Create a new entry in the password store. +[d]el [name]: Delete an entry from the password store. +[s]how [name]: Show password from an entry in the password store. +[l]ist: List all entries from the password store. + +OPTIONS + +−n Limit passwords to alphanumeric characters. +−l Length of generated passwords. +−c Copy password to clipboard. +−q Don't print password to stdout. +−h Show usage and exit. +−v Show version and exit. ``` ## TODO