From 31ffcf07bce4011189e034db363452e80df21fa7 Mon Sep 17 00:00:00 2001 From: Stefan Kreutz Date: Mon, 23 May 2022 22:13:18 +0200 Subject: Describe usage --- README.md | 13 +++++++++++-- 1 file 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. -- cgit v1.2.3