Skip to content

Commit f463d01

Browse files
author
Evan Sims
committed
Update README.md
1 parent bec93e2 commit f463d01

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# Laravel Auth0 Plugin
22

3-
This plugin helps you integrate your [Laravel](https://laravel.com/) WebApp with [Auth0](https://auth0.com/) to achieve Single Sign On with a few simple steps.
4-
5-
- Master targets compatibility with Laravel 5.7 and above.
6-
- The 3.x branch (not maintained) targets Laravel 5.2 compatibility.
7-
- The 2.x branch (not maintained) targets Laravel 5.0 and 5.1 compatibility.
8-
- If you are working with an older version (Laravel 4.x), use version 1.0.* (not maintained)
9-
103
[![CircleCI](https://img.shields.io/circleci/project/github/auth0/laravel-auth0/master.svg)](https://circleci.com/gh/auth0/laravel-auth0)
114
[![Latest Stable Version](https://poser.pugx.org/auth0/login/v/stable)](https://packagist.org/packages/auth0/login)
125
[![License](https://poser.pugx.org/auth0/login/license)](https://packagist.org/packages/auth0/login)
136
[![Total Downloads](https://poser.pugx.org/auth0/login/downloads)](https://packagist.org/packages/auth0/login)
147
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fauth0%2Flaravel-auth0.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fauth0%2Flaravel-auth0?ref=badge_shield)
158

9+
This plugin helps you integrate your [Laravel](https://laravel.com/) WebApp with [Auth0](https://auth0.com/) to achieve Single Sign On with a few simple steps.
10+
11+
## Supported Framework Versions
12+
13+
Our plugin maintains support for [all actively supported versions](https://laravel.com/docs/8.x/releases#support-policy) of the Laravel framework, including [6.X (LTS)](https://laravel.com/docs/8.x/releases), [7.X](https://laravel.com/docs/7.x/releases) and [8.X](https://laravel.com/docs/8.x/releases).
14+
15+
Past releases of our plugin may potentially run on earlier, now unsupported versions of the Laravel framework, but these releases are not maintained. The final release of our plugin to support the Laravel 5.X series was 6.1.0.
16+
1617
## Documentation
1718

1819
Please see the [Laravel webapp quickstart](https://auth0.com/docs/quickstart/webapp/laravel) for a complete guide on how to install this in an existing project or to download a pre-configured sample project. Additional documentation on specific scenarios is below.
@@ -50,6 +51,7 @@ You can customize the way you handle the users in your application by creating y
5051
### Using auth guard
5152

5253
To protect APIs using an access token generated by Auth0, there is an `auth0` API guard provided ([Laravel documentation on guards](https://laravel.com/docs/7.x/authentication#adding-custom-guards)). To use this guard, add it to `config/auth.php` with the driver `auth0`:
54+
5355
```
5456
'guards' => [
5557
...
@@ -68,6 +70,7 @@ To protect APIs using an access token generated by Auth0, there is an `auth0` AP
6870
```
6971

7072
Once that has been added, add the guard to the middleware of any API route and check authentication during the request:
73+
7174
```
7275
// get user
7376
auth('auth0')->user();
@@ -118,5 +121,4 @@ Auth0 helps you to easily:
118121

119122
The Auth0 Laravel Login plugin is licensed under MIT - [LICENSE](LICENSE.txt)
120123

121-
122-
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fauth0%2Flaravel-auth0.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fauth0%2Flaravel-auth0?ref=badge_large)
124+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fauth0%2Flaravel-auth0.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fauth0%2Flaravel-auth0?ref=badge_large)

0 commit comments

Comments
 (0)