added Usage readme section

hiqdev · Aug 20, 2017 · e98fd7d · e98fd7d
1 parent 04003e2
commit e98fd7d
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -63,6 +63,20 @@ For more details please see [src/config/params.php].
 [src/config/params.php]:    src/config/params.php
 [src/config/web.php]:       src/config/web.php
 
+## Usage
+
+This plugin provides behavior and configuration attaches it
+to user component on beforeLogin` event.
+And then the behavior validates IPs and TOTP on every login.
+
+To use this plugin you need to provide:
+
+- `allowed_ips` readable and writable property in your **user** component for allowed IPs functionality
+- `totp_secret` readable and writable property in your **user** component for TOTP functionality
+
+IPs and TOTP functions are independent and you can provide just one of properties to have only
+corresponding functionality.
+
 ## License
 
 This project is released under the terms of the BSD-3-Clause [license](LICENSE).

diff --git a/docs/readme/Usage.md b/docs/readme/Usage.md
@@ -0,0 +1,11 @@
+This plugin provides behavior and configuration attaches it
+to user component on beforeLogin` event.
+And then the behavior validates IPs and TOTP on every login.
+
+To use this plugin you need to provide:
+
+- `allowed_ips` readable and writable property in your **user** component for allowed IPs functionality
+- `totp_secret` readable and writable property in your **user** component for TOTP functionality
+
+IPs and TOTP functions are independent and you can provide just one of properties to have only
+corresponding functionality.