Skip to content

Commit 638f032

Browse files
committed
Improved documentation
1 parent d4b6e6e commit 638f032

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -61,22 +61,22 @@ After authenticating the user on Auth0, we will do a GET to a URL on your web si
6161

6262
You can trigger the login in different ways, like redirecting to a login link or using the [Login Widget](https://docs.auth0.com/login-widget2), by adding the following javascript into your page
6363

64-
65-
<a href="javascript:widget.signin();">Login</a>
66-
67-
<script src="https://cdn.auth0.com/w2/auth0-widget-3.0.min.js"></script>
68-
<script type="text/javascript">
69-
var widget = new Auth0Widget({
70-
domain: 'YOUR_AUTH0_DOMAIN',
71-
clientID: 'YOUR_AUTH0_CLIENT_ID',
72-
callbackURL: 'http://<name>/callback.php'
73-
});
74-
</script>
75-
64+
~~~html
65+
<a href="javascript:widget.signin();">Login</a>
66+
67+
<script src="https://cdn.auth0.com/w2/auth0-widget-3.0.min.js"></script>
68+
<script type="text/javascript">
69+
var widget = new Auth0Widget({
70+
domain: 'YOUR_AUTH0_DOMAIN',
71+
clientID: 'YOUR_AUTH0_CLIENT_ID',
72+
callbackURL: 'http://<name>/callback.php'
73+
});
74+
</script>
75+
~~~
7676

7777
### 5. (Optional) Configure session data
7878

79-
By default, the SDK will store the [user information](https://docs.auth0.com/user-profile) in the `PHP Session` and it will discard the access token and the id token. If you like to persist them as well, you can pass `persist_access_token => true` and `persist_id_token => true` to the SDK configuration in step 2. You can also disable session all together by passing `store => false`.
79+
By default, the SDK will store the [user information](https://docs.auth0.com/user-profile) in the `PHP Session` and it will discard the access token and the id token. If you like to persist them as well, you can pass `'persist_access_token' => true` and `'persist_id_token' => true` to the SDK configuration in step 2. You can also disable session all together by passing `'store' => false`.
8080

8181
If you want to change `PHP Session` and use Laravel, Zend, Symfony or other abstraction to the session, you can create a class that implements `get`, `set`, `delete` and pass it to the SDK as following.
8282

@@ -125,4 +125,5 @@ This SDK uses [Composer](http://getcomposer.org/doc/01-basic-usage.md) to manage
125125

126126
- Better code documentation
127127
- Better user guide
128+
- Create an interface for the store
128129
- Drink coffee

0 commit comments

Comments
 (0)