README.md in tfa-0.0.5 vs README.md in tfa-0.0.6
- old
+ new
@@ -1,33 +1,61 @@
-# tfa
+# two factor authentication
[](https://travis-ci.org/mokhan/tfa)
+[](https://codeclimate.com/github/mokhan/tfa)
+[](https://gitter.im/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:
+```ruby
+ 'otpauth://totp/alice@google.com?secret=JBSWY3DPEHPK3PXP'
+```
+
## Installation
-Add this line to your application's Gemfile:
+ $ gem install tfa
- gem 'tfa'
+## Usage
-And then execute:
+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.
- $ bundle
+```shell
+ $ tfa add development <secret>
+```
-Or install it yourself as:
+To display the secret associated with a key:
- $ gem install tfa
+```shell
+ $ tfa show development
+```
-## Usage
+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
1. Fork it ( https://github.com/mokhan/tfa/fork )