Skip to content

Commit 030bb31

Browse files
author
Diego Hernandes
authored
Update readme.md
1 parent 5aa17a9 commit 030bb31

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

readme.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# Laravel JWT
21

32
![Readme Art](http://imageshack.com/a/img922/4489/tftxQ1.png)
43

4+
# Laravel JWT
5+
56
This package provides out-of-the-box API authentication using JWT for Laravel.
67

78
## Installation.
@@ -17,7 +18,7 @@ composer require codecasts/laravel-jwt
1718
In order to setup this package into your application, minimal configuration
1819
is actually needed.
1920

20-
#### 1) Service Provider.
21+
### 1) Service Provider.
2122

2223
Register this package's Service Provider by adding it to the `providers`
2324
section of your `config/app.php` file:
@@ -32,7 +33,7 @@ section of your `config/app.php` file:
3233
],
3334
```
3435

35-
#### 2) Configuration file.
36+
### 2) Configuration file.
3637

3738
Publish the configuration file (`config/jwt.php`) by running the
3839
following command after registering the Service Provider.
@@ -41,7 +42,7 @@ following command after registering the Service Provider.
4142
php artisan vendor:publish --provider="Codecasts\Auth\JWT\ServiceProvider"
4243
```
4344

44-
#### 3) Generate a Secret.
45+
### 3) Generate a Secret.
4546

4647
In order for this package to works, you will need a separate secret
4748
(do not use the application key).
@@ -59,7 +60,7 @@ Then, copy the generated key contents into your `.env` file.
5960
**NOTICE**: The key generation process will not automatically
6061
set it inside your `.env` file, do it manually.
6162

62-
#### 4) Setup Guard
63+
### 4) Setup Guard
6364

6465
In order to automatically authenticate your routes using `JWT` tokens,
6566
you need to change the guard driver to `jwt`
@@ -99,7 +100,7 @@ will be added on this package when it reaches it's 1.0 version.
99100
This package is fully integrated with Laravel Authentication.
100101

101102
The default configuration (`config/jwt.php`) brings a sensitive value that
102-
is very useful when your application is not completely an API: **`'middleware_match`**
103+
is very useful when your application is not completely an API: **`middleware_match`**
103104

104105
By not completely an API, I mean, the JWT guard is not the default one.
105106

@@ -110,8 +111,9 @@ This configuration key allows non protected routes to work properly.
110111

111112
Notice that this option will match middleware group names with guard names.
112113

113-
> In this case, the 'api' middleware group will always use the `api` guard.
114-
> Also, the 'web' middleware group will always use the `web` guard.
114+
**In this case, the 'api' middleware group will always use the `api` guard.**
115+
116+
**Also, the 'web' middleware group will always use the `web` guard**
115117

116118
If you do not use this value, you will need to use suffixes when referencing the
117119
`auth` middleware, like `auth:api`.
@@ -125,8 +127,8 @@ you can just expect create a Guard current implementation from the IoC and work
125127
Check out the examples.
126128

127129

128-
** On the following examples, all Guard instances are injected from `Illuminate\Contracts\Auth\Guard` **
129-
** On the following examples, all Request instances are injected from `Illuminate\Http\Request` **
130+
**On the following examples, all Guard instances are injected from `Illuminate\Contracts\Auth\Guard`**
131+
**On the following examples, all Request instances are injected from `Illuminate\Http\Request`**
130132

131133
#### Token from User Instance.
132134

0 commit comments

Comments
 (0)