From 49678fbfd57ada98a33cd0ca5f65103f8b87eb84 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Sat, 2 Jan 2016 01:19:20 -0800 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 2888ade..643872c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A commandline Authenticator App (for Authy, Google Authenticator, Microsoft Authenticator, Facebook Authenticator, TOTP, etc) +## Install + **Install node.js 4.0+**: ```bash @@ -13,6 +15,29 @@ curl -L https://bit.ly/iojs-min | bash npm install --global authenticator-cli ``` +## Usage + +``` +authenticator --help +``` + +``` +authenticator --generate --issuer "ACME" --account "user@example.com" + +Key: ru36 53z3 fmh4 d67u kgeh 7rgj hcbb ypnd +Token: 947464 +URL: otpauth://totp/ACME:user@example.com?secret=RU3653Z3FMH4D67UKGEH7RGJHCBBYPND&issuer=ACME&algorithm=SHA1&digits=6&period=30 +``` + +## Browser & Node Authenticator + +You may also be interested in + +* [Browser Authenticator](https://github.com/Daplie/browser-authenticator) over at +* [Node.js Authenticator](https://github.com/Daplie/node-authenticator) over at + +## Full Usage + ``` Usage: authenticator [OPTIONS]