Author: Adam <git@apiote.tk>
update README
README.asciidoc | 42 ++++++++++++++++++++++++++++++++++++++++--
diff --git a/README.asciidoc b/README.asciidoc index 6c30c013184be45e2bfe120caac2c2a22407ff28..e53ab411a39b52ee6aef97386aa1a03cb6b3000e 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -1,5 +1,43 @@ -=Next-Eeze += Next-Eeze Client for Nextcloud Passwords. -*Work in progress. Not secure. Do not use in production.* +Next-Eeze (Ident-I-Eeze for Nextcloud) can + +* download passwords from Nextcloud instance, +* list entries (Label/Username) +* show entry + +Only server-side encryption is supported. Client-side encryption is not supported. + +== Security precautions + +* credentials and all passwords are encrypted with master password before storing on disk +* no information is kept in memory longer than needed + +==== TODO +* guard secrets in memory + +== Agent + +Next-Eeze can use Next-Eeze-Agent to remeber master password. + +So far only running agent is used to get password. Next-Eeze cannot start the agent nor give it the password. + +== Usage + +``` +Usage of next-eeze: + + -C Config + -i in Config: set server, username, password (initialise) + -r in Config: reëncrypt (change master password) + -G Get + -l filter Get by label (default "") + -s filter Get by url (service/server) (default "") + -u filter Get by username (default "") + -f show full entry in Get, instead of just username/password + -p show just password in Get + -L List + -S Sync +```