summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2014-07-26 09:51:06 -0600
committermo khan <mo@mokhan.ca>2014-07-26 09:51:06 -0600
commitc5135af9a3ea3d3fc64b944cba2f8503ca449401 (patch)
treec643e385cc39cac636655393b63c2a54d20b2535
parentc6f6269d9f8c9bc698cf0e25bb4b2dd7bd92c25e (diff)
update readme.
-rw-r--r--README.md52
1 files changed, 39 insertions, 13 deletions
diff --git a/README.md b/README.md
index dfb313b..343767e 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,59 @@
-# tfa
+# two factor authentication
[![Build Status](https://travis-ci.org/mokhan/tfa.svg?branch=v0.0.2)](https://travis-ci.org/mokhan/tfa)
[![Code Climate](https://codeclimate.com/github/mokhan/tfa.png)](https://codeclimate.com/github/mokhan/tfa)
-Create a one time password for your different environments.
+This CLI helps to manage your one time passwords for different accounts/environments.
+The goal of this tool is to help you generate one time passwords quickly
+from the command line that you can pipe into your clipboard. This saves
+you from having to pull out your phone and cracking open the Google
+Authenticator app to generate a one time password.
+In order to use this software you will need access to the secret
+embedded in the provisioning uri used to set up your two factor
+authentication account. This usually comes in the form of a QR Code
+and might look like:
-## Installation
+```ruby
+ 'otpauth://totp/alice@google.com?secret=JBSWY3DPEHPK3PXP'
+```
-Add this line to your application's Gemfile:
+## Installation
- gem 'tfa'
+ $ gem install tfa
-And then execute:
+## Usage
- $ bundle
+To add a secret you can use the add command. The key you use can be
+anything you choose. In the example below the key is development.
-Or install it yourself as:
+```shell
+ $ tfa add development <secret>
+```
- $ gem install tfa
+To display the secret associated with a key:
-## Usage
+```shell
+ $ tfa show development
+```
+To generate a time based one time password for a specific key.
```shell
- $ tfa add
- $ tfa add develoment <secret>
- $ tfa show development
$ tfa totp development
+ $ 260182
+```
+
+You can also pipe it to your clipboard.
+
+```shell
+ $ tfa totp development | pbcopy
+```
+
+or
+
+```shell
+ $ tfa totp development | xclip -selection clipboard
```
## Contributing