From 16f7d3f1e3ef999c9515b93f0525d0e2db215633 Mon Sep 17 00:00:00 2001
From: Nat Lasseter <user@4574.co.uk>
Date: Thu, 19 Dec 2019 09:44:27 +0000
Subject: Added cli options and clipboard copying

---
 Readme.textile | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

(limited to 'Readme.textile')

diff --git a/Readme.textile b/Readme.textile
index 123c0d6..3051c29 100644
--- a/Readme.textile
+++ b/Readme.textile
@@ -2,12 +2,30 @@ h1. twofa
 
 p. A terrible, should-not-be-used, wrote-it-for-fun-and-learning 2fa authenticator.
 
+h2. Requirements
+
+p. twofa requires the _base32_ and _optimist_ gems.
+
+h3. Clipboard
+
+p. For clipboard tasks, twofa requires the _clipboard_ gem, and either the _xclip_ or _xsel_ application.
+
 h2. Usage
 
-bc. $ twofa ISSUER
+bc.. $ twofa -h
+twofa is a command line TOTP code generator.
+
+Usage:
+  twofa [opts] ISSUER
+
+where [opts] are:
+  -n, --no-clip           Do not copy code to the clipboard
+  -t, --twofa-file=<s>    Location of the twofa secrets file (default: /home/nl987/.twofa)
+  -v, --version           Print version and exit
+  -h, --help              Show this message
 
-h3. @~/.twofa@
+h3. twofa secrets file
 
-p. The twofa rc file has the format:
+p. The twofa secrets file is normally found at @~./twofa@, and has the format:
 
 bc. ISSUER SECRET [interval | default(30)] [length | default(6)] [hashing algorithm | default(sha1)]
-- 
cgit v1.2.1