summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCasey Robinson <casey.robinson@distilnetworks.com>2014-12-18 15:40:19 -0500
committerCasey Robinson <casey.robinson@distilnetworks.com>2014-12-18 15:40:19 -0500
commit3b5d462058022c43a3d8afe09c1ba7f2d8c62e93 (patch)
tree8b7d9bbd0fe2c8bf217a463ca0d6343cdc1c5841
parent33e493b06315e065b7a85233eb49b531b953c9cb (diff)
downloadonetime-3b5d462058022c43a3d8afe09c1ba7f2d8c62e93.tar.gz
onetime-3b5d462058022c43a3d8afe09c1ba7f2d8c62e93.tar.bz2
onetime-3b5d462058022c43a3d8afe09c1ba7f2d8c62e93.zip
add example usage to readme
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3597ddb..f3e1466 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,12 @@ Two Factor Authentication
The goal of this project is to provide a command line application for online accounts that use TOTP for two factor authentication.
+## Usage
+onetime reads lines of "<provider>,<secret>" on stdin and generates the code for each one.
+
+example:
+ echo "github,cknvzzwywgm6unyk" | ./onetime
+
## TOTP
As defined in [RFC 6238](http://tools.ietf.org/html/rfc6238), Time-Based One-Time Password Algorithm (TOTP) is an extension of the HMAC-based One-Time Password (HOTP) algorithm.
HOTP computes a user-friendly version of the checksum of two input values, a shared secret and a counter.