Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
j256 authored Apr 7, 2017
1 parent 12efab5 commit bc1a61c
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ You can use this code with the Google Authenticator mobile app or the Authy mobi

## To get this to work you:

1. Use `generateBase32Secret()` to generate a secret key for a user.
1. Use `generateBase32Secret()` to generate a secret key for a user. For example: `"NY4A5CPJZ46LXZCP"`
2. Store the secret key in the database associated with the user account.
3. Display the QR image URL returned by `qrImageUrl(...)` to the user.
3. Display the QR image URL returned by `qrImageUrl(...)` to the user. Here's a sample from GoogleAPIs:
![Sample QR Image](https://chart.googleapis.com/chart?chs=200x200&cht=qr&chl=200x200&chld=M|0&cht=qr&chl=otpauth://totp/[email protected]%3Fsecret%3DNY4A5CPJZ46LXZCP)
4. User uses the image to load the secret key into his authenticator application.

## Whenever the user logs in:
Expand All @@ -23,10 +24,3 @@ You can use this code with the Google Authenticator mobile app or the Authy mobi
4. If they are equal then the user is allowed to log in.

For more details, see the [example program](https://github.com/j256/two-factor-auth/blob/master/src/test/java/com/j256/twofactorauth/TwoFactorAuthExample.java).

## Sample QR Image

The following is a sample QR image generated by GoogleAPIs URL. It is the QR code for the base-32 encoded
secret `"NY4A5CPJZ46LXZCP"`. See the [example program](https://github.com/j256/two-factor-auth/blob/master/src/test/java/com/j256/twofactorauth/TwoFactorAuthExample.java) for more details.

![Sample QR Image](https://chart.googleapis.com/chart?chs=200x200&cht=qr&chl=200x200&chld=M|0&cht=qr&chl=otpauth://totp/[email protected]%3Fsecret%3DNY4A5CPJZ46LXZCP)

0 comments on commit bc1a61c

Please sign in to comment.