summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Kreutz <mail@skreutz.com>2022-05-23 22:13:18 +0200
committerStefan Kreutz <mail@skreutz.com>2022-05-23 22:13:18 +0200
commit31ffcf07bce4011189e034db363452e80df21fa7 (patch)
treebfad53e26af6c59e01bc3c2cd37639f92d08537b
parent0e3b55c81e218a93d6cdd157d1ca3785bc32c49e (diff)
downloadjotpass-31ffcf07bce4011189e034db363452e80df21fa7.tar
Describe usage
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index 32622ab..bf48b63 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,17 @@
# Jotpass
Jotpass is a BSD utility that facilitates generating random passwords suitable for handwriting.
-See [this](https://www.skreutz.com/posts/readable-random-passwords-with-jot/) blog post for an introduction, and refer to the man page for details.
+See [this](https://www.skreutz.com/posts/readable-random-passwords-with-jot/) blog post for an introduction.
-## Install
+## Usage
+
+Print a random password:
+
+ $ jotpass
+ P6ji-4pRZ-Ze7m-q7Bp-Vpye-HCjr-hygF-6TwQ-oRJT-yx6p-SyMB-AwUm
+
+See the manual page for the available options.
+
+## Installation
Run `make install` as root to install the `jotpass` utility and man page.
Generated by cgit. See skreutz.com for my tech blog and contact information.