summaryrefslogtreecommitdiff
path: root/plugins/EmailAuthentication/README
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/EmailAuthentication/README')
-rw-r--r--plugins/EmailAuthentication/README7
1 files changed, 7 insertions, 0 deletions
diff --git a/plugins/EmailAuthentication/README b/plugins/EmailAuthentication/README
new file mode 100644
index 000000000..320815689
--- /dev/null
+++ b/plugins/EmailAuthentication/README
@@ -0,0 +1,7 @@
+The Email Authentication plugin allows users to login using their email address.
+
+The provided email address is used to lookup the user's nickname, then that nickname and the provided password is checked.
+
+Installation
+============
+add "addPlugin('emailAuthentication');" to the bottom of your config.php