Skip to content

Commit

Permalink
Add usage instructions and screenshots (#287)
Browse files Browse the repository at this point in the history
  • Loading branch information
kasparsd authored Apr 27, 2019
1 parent 3350cce commit 63de5fc
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 0 deletions.
Binary file added assets/screenshot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,26 @@ Enable Two-Factor Authentication using time-based one-time passwords (OTP, Googl

## Description ##

Use the "Two-Factor Options" section under "Users" → "Your Profile" to enable and configure one or multiple two-factor authentication providers for your account:

- Email codes
- Time Based One-Time Passwords (TOTP)
- FIDO Universal 2nd Factor (U2F)
- Backup Codes
- Dummy Method (only for testing purposes)

For more history, see [this post](https://stephanis.info/2013/08/14/two-cents-on-two-factor/).

## Screenshots ##

### Two-factor options under User Profile.

![Two-factor options under User Profile.](assets/screenshot-1.png)

### U2F Security Keys section under User Profile.

![U2F Security Keys section under User Profile.](assets/screenshot-2.png)

## Get Involved ##

Development happens [on GitHub](https://github.com/georgestephanis/two-factor/). Join the `#core-passwords` channel [on WordPress Slack](http://wordpress.slack.com) ([sign up here](http://chat.wordpress.org)).
Expand Down
15 changes: 15 additions & 0 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,23 @@ Stable tag: trunk
Enable Two-Factor Authentication using time-based one-time passwords (OTP, Google Authenticator), Universal 2nd Factor (FIDO U2F, YubiKey), email and backup verification codes.

== Description ==

Use the "Two-Factor Options" section under "Users" → "Your Profile" to enable and configure one or multiple two-factor authentication providers for your account:

- Email codes
- Time Based One-Time Passwords (TOTP)
- FIDO Universal 2nd Factor (U2F)
- Backup Codes
- Dummy Method (only for testing purposes)

For more history, see [this post](https://stephanis.info/2013/08/14/two-cents-on-two-factor/).


== Screenshots ==

1. Two-factor options under User Profile.
2. U2F Security Keys section under User Profile.


== Get Involved ==

Expand Down

0 comments on commit 63de5fc

Please sign in to comment.