mirror/php-auth
1
0
Fork 0
mirror of https://github.com/delight-im/PHP-Auth.git synced 2025-08-05 07:37:25 +02:00
Code Issues Releases Wiki Activity

Add table of contents to 'Usage' section in README

Browse Source
This commit is contained in:
Marco
2017-01-30 19:10:28 +01:00
parent 6db82d1f65
commit f5027c09e9
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -40,6 +40,27 @@ Completely framework-agnostic and database-agnostic.
## Usage
* [Creating a new instance](#creating-a-new-instance)
* [Registration (sign up)](#registration-sign-up)
* [Login (sign in)](#login-sign-in)
* [Email verification](#email-verification)
* [Keeping the user logged in](#keeping-the-user-logged-in)
* [Password reset ("forgot password")](#password-reset-forgot-password)
* [Changing the current user's password](#changing-the-current-users-password)
* [Logout](#logout)
* [Accessing user information](#accessing-user-information)
* [Login state](#login-state)
* [User ID](#user-id)
* [Email address](#email-address)
* [Display name](#display-name)
* [Checking whether the user was "remembered"](#checking-whether-the-user-was-remembered)
* [IP address](#ip-address)
* [Additional user information](#additional-user-information)
* [Utilities](#utilities)
* [Creating a random string](#creating-a-random-string)
* [Creating a UUID v4 as per RFC 4122](#creating-a-uuid-v4-as-per-rfc-4122)
* [Reading and writing session data](#reading-and-writing-session-data)
### Creating a new instance
```php