Merge branch 'master' of github.com:thecodework/two-factor-authentication

Author: imrealashu

README.md

@@ -13,52 +13,32 @@ This package lets you setup your two factor authentication for your existing lar
   - Google Authenticator [Android](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en) - [iOS](https://itunes.apple.com/in/app/google-authenticator/id388497605?mt=8) or [Authy](https://www.authy.com/) mobile app
 
 ## Installation
+**1. Composer Install**
 ```bash
 $ composer require thecodework/two-factor-authentication:0.1.0
 ```
 Note: The current version of the package is beta release, so be careful before using it for production applications.
 
-After requiring the package simply run
-```bash
-$ php artisan migrate
-```
-It will use the default User model and adds two columns `is_2fa_enabled` and `secret_key`
+**2. Add Service Provider**
+After requiring the package add `TwoFactorAuthenticationServiceProvider::class` into providors array in `app.php` confi file
 
-To publish config file
-```
-$ php artisan vendor:publish --provider="Thecodework\TwoFactorAuthentication\TwoFactorAuthenticationServiceProvider" --tag=config
-```
-Once the config file is published you can navigate to config directory of your application and look for `2fa-config.php` file and change configuration as you want.
-The config file will look like this and have following configurable option.
 ```php
-    /*
-     * Specify redirect url after when token authentication
-     * is successfull.
-     */
-    'redirect_to' => '/home',
-
-    /*
-     * Account name which will be used as label to show on
-     * authenticator mobile application.
-     */
-    'account_name' => 'Thecodework 2FA',
-
-    /*
-     * Currntly Support 'Sha1'
-     * The library works with the Google Authenticator application
-     * for iPhone and Android. Google only supports SHA-1 digest algorithm,
-     * 30 second period and 6 digits OTP. Other values for these parameters
-     * are ignored by the Google Authenticator application.
-     */
-    'digest_algorithm' => 'sha1',
+[
+ 'providers' => [
+    //... 
+    Thecodework\TwoFactorAuthentication\TwoFactorAuthenticationServiceProvider::class
+  ]
+]
+```
 
-    /*
-     * Number of digits can be max 30
-     * To Support Google Authenticator
-     */
-    'number_of_digits' => 8,
+**3. Run Migrations**
+Now run the migration
+```bash
+$ php artisan migrate
 ```
+It will use the default User model and adds two columns `is_2fa_enabled` and `secret_key`.
 
+**4. Add `AuthenticatesUserWith2FA` trait in the LoginController**
 Now the config file is placed. The last thing to do is addding `AuthenticatesUsersWith2FA` trait in the  `Http/Controllers/Auth/LoginController.php` file which helps to stop user at verify-2fa page to enter TOTP token after each login.
 
 The final snippet will look like this.
@@ -67,7 +47,17 @@ use AuthenticatesUsers, AuthenticatesUsersWith2FA {
     AuthenticatesUsersWith2FA::authenticated insteadof AuthenticatesUsers;
 }
 ```
-Now login to the application and visit `setup-2fa` route, which will show a barcode which can be scanned either using Google Authenticator or Authy mobile application as described above.
+Note: Don't forget to include use statement `use Thecodework\TwoFactorAuthentication\AuthenticatesUsersWith2FA` in the header.
+
+**5. Publish the ConfigFile**
+Finally publish config file
+```
+$ php artisan vendor:publish --provider="Thecodework\TwoFactorAuthentication\TwoFactorAuthenticationServiceProvider" --tag=config
+```
+Once the config file is published you can navigate to config directory of your application and look for `2fa-config.php` file and change configuration as you want.
+**6. Setup 2FA for user**
+
+Now login to the application and visit `/setup-2fa/` route, which will show a barcode which can be scanned either using Google Authenticator or Authy mobile application as described above.
 Scan that code and click **Enable Two Factor Authentication**.
 
 Now perform logout and log back in again, it will ask you to enter Token which can be obtain from the authenticator mobile application. Enter the token and you're logged in.