Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Moc committed Jan 21, 2021
1 parent 62adc0f commit e9f4bc2
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,20 @@
**This plugin is currently in development and should not be used on a production environment or live website yet.**

## Features
This plugin adds Two Factor Authentication (2FA). It can be used in combination with any [authentication app](https://github.com/e107inc/twofactorauth/#recommended-authenticator-applications) on your (mobile) device.
This plugin adds Two Factor Authentication (2FA) to an e107 installation. It can be used in combination with any [authentication app](https://github.com/e107inc/twofactorauth/#recommended-authenticator-applications) on your (mobile) device.

It makes use of the [TwoFactorAuth Library by RobThree](https://github.com/RobThree/TwoFactorAuth).

### Current features
* 2FA support for **User** login.
* Admins can disable 2FA for a specific user
* Ability to change "Label", used in the authentication application.
* 2FA support for login (both user and admin)
* Admins can disable 2FA for a specific user (as fallback)
* Ability to change "Label" (used in the authentication application)

### Features planned for future releases:
* 2FA support for **Admin** login.
* Other QR Code providers
### Features planned for future releases:
* See [Issue tracker](https://github.com/e107inc/twofactorauth/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+planned%22+label%3A%22type%3A+enhancement%22)

## Requirements ##
* e107 v2.3.1+ (latest)
* e107 v2.3.1+
* cURL extension

## Recommended authenticator applications
Expand All @@ -33,11 +32,11 @@ It makes use of the [TwoFactorAuth Library by RobThree](https://github.com/RobTh
* Then, if you cannot find the answer to your question, please submit a new issue in the issue tracker [here](https://github.com/e107inc/twofactorauth/issues)

## Bugs & feature requests ##
* Bug reports and feature requests are very welcome!
* Use the [issue tracker](https://github.com/e107inc/twofactorauth/issues)
* Feature requests or suggestions are very welcome!

## Translation ##
In case you want to translate this plugin to your language, please [fork this Github repository](https://help.github.com/articles/fork-a-repo) and submit a pull-request.
*In case you want to translate this plugin to your language, please [fork this Github repository](https://help.github.com/articles/fork-a-repo) and submit a pull-request.

More information on pull-requests can be found [here](https://help.github.com/articles/using-pull-requests) and [here](https://guides.github.com/overviews/flow/).
I also recommend using the [Github for Desktop](https://desktop.github.com/) tools.
Expand Down

0 comments on commit e9f4bc2

Please sign in to comment.