summaryrefslogtreecommitdiff
path: root/plugins/genpass/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/genpass/README.md')
-rw-r--r--plugins/genpass/README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/plugins/genpass/README.md b/plugins/genpass/README.md
index e6e7a5138..a5ff4a876 100644
--- a/plugins/genpass/README.md
+++ b/plugins/genpass/README.md
@@ -5,21 +5,22 @@ has at least a 128-bit security margin and generates passwords from the
cryptographically secure `/dev/urandom`. Each generator can also take an
optional numeric argument to generate multiple passwords.
-Requirements:
+To use it from an interactive ZSH, add `genpass` to the plugins array in your
+zshrc file:
-* `grep(1)`
-* GNU coreutils (or appropriate for your system)
-* Word list providing `/usr/share/dict/words`
+ plugins=(... genpass)
-To use it, add `genpass` to the plugins array in your zshrc file:
+You can also invoke password generators directly (they are implemented as
+standalone executable files), which can be handy when you need to generate
+passwords in a script:
- plugins=(... genpass)
+ ~/.oh-my-zsh/plugins/genpass/genpass-apple 3
## genpass-apple
Generates a pronounceable pseudoword passphrase of the "cvccvc" consonant/vowel
syntax, inspired by [Apple's iCloud Keychain password generator][1]. Each
-pseudoword has exactly 1 digit placed at the edge of a "word" and exactly 1
+password has exactly 1 digit placed at the edge of a "word" and exactly 1
capital letter to satisfy most password security requirements.
% genpass-apple