Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix typos in README #65

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix typos in README #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Two Factor Authentication or 2-Step Verification provides stronger security for
```bash
$ composer require thecodework/two-factor-authentication
```
*Note* - If your're using Laravel 5.5 or newer version then auto-discovery-pacakge would automatically update the providers and you could skip to **Step 3**
*Note* - If you're using Laravel 5.5 or newer version then the Laravel's auto-discovery will automatically update the providers and you could skip to **Step 3**

**2. Add Service Provider**

Expand All @@ -41,7 +41,7 @@ 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.
Once the config file is published you can navigate to the config directory of your application and look for `2fa-config.php` file and change configuration as you want.

**4. Run Migrations**

Expand All @@ -53,7 +53,7 @@ It will use the default User model and adds two columns `is_2fa_enabled` and `se

**5. 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.
Now the config file is placed. The last thing to do is adding `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.
```php
Expand All @@ -63,11 +63,11 @@ use AuthenticatesUsers, AuthenticatesUsersWith2FA {
```
Note: Don't forget to include use statement `use Thecodework\TwoFactorAuthentication\AuthenticatesUsersWith2FA` in the header.

**6. Setup 2FA for user**
**6. Set up 2FA for user**

**• Enable 2FA**

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.
Now login to the application and visit `/setup-2fa/` route, which will show a barcode that can be scanned either using Google Authenticator or Authy mobile application as described above.
Scan that code and click **Enable Two Factor Authentication**.

**• Disable 2FA**
Expand All @@ -76,7 +76,7 @@ To disable Two Factor, visit `/setup-2fa` route, which will now show a **Disable

**7. Testing 2FA**

Now to test 2FA, 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.
Now to test 2FA, perform log out and log back in again, it will ask you to enter Token which can be obtained from the authenticator mobile application. Enter the token and you're logged in.

### Additionally
If you want to publish views, and migration as well along with config file then run
Expand All @@ -85,4 +85,4 @@ $ php artisan vendor:publish --provider="Thecodework\TwoFactorAuthentication\Two
```

## Contribution
Feel free to create issues, submit PRs and talk about features and enhancement through proposing issue. If you find any security consideration, instead of creating an issue send an email to [imrealashu@gmail.com](mailto:imrealashu@gmail.com).
Feel free to create issues, submit PRs and talk about features and enhancement through proposing issues. If you find any security consideration, instead of creating an issue send an email to [imrealashu@gmail.com](mailto:imrealashu@gmail.com).