Update README.md and CHANGELOG.md

juliomotol · Oct 12, 2020 · 13ac1b5 · 13ac1b5
1 parent c211fad
commit 13ac1b5
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,12 @@
 # Changelog
 
+## v2.2.0 (2020-10-12)
+
+-   Added `AuthTimeout` facade.
+
 ## v2.1.0 (2020-09-11)
 
--   Added support for Laravel 8.x
+-   Added support for Laravel 8.x.
 
 ## v2.0.0 (2020-08-03)
 

diff --git a/README.md b/README.md
@@ -32,6 +32,7 @@ Laravel Auth Timeout is a small middleware package that checks if the user had m
     -   [Custom Guards](#custom-guards)
     -   [AuthTimeoutEvent](#authtimeoutevent)
     -   [Redirection](#redirection)
+    -   [AuthTimeout Facade](#authtimeout-facade)
 
 ## Installation
 
@@ -157,6 +158,14 @@ class AuthTimeoutMiddleware extends BaseMiddleware
 
 > Don't forget to use your extended `AuthTimeoutMiddleware` in the `Kernel.php`.
 
+### AuthTimeout Facade
+
+This package also provides a facade with the following methods:
+
+-   `AuthTimeout::init()` - Initialize the timeout session when no has been set yet.
+-   `AuthTimeout::check($guard = null)` - Check if a user has timed out and logs them out if so.
+-   `AuthTimeout::reset()` - Reset the user's timeout session.
+
 ## Contributing
 
 Contributions are **welcome** and will be fully **credited**. We accept contributions via Pull Requests on [Github](https://github.com/juliomotol/larvel-auth-timeout).