summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristoph Burschka2014-01-16 04:25:51 +0100
committerChristoph Burschka2014-01-16 04:25:51 +0100
commit86a4fd69d53b61a624dfc332c7a0e70b9a79218a (patch)
tree4f9c652f7ea30737b29a0864ac1806919cbc1314 /README.md
parentFormatting of README headings. (diff)
downloadejabberd-auth-php-86a4fd69d53b61a624dfc332c7a0e70b9a79218a.tar.gz
Implement smf2_session and finish RPC code. (#1)
This patch should be ready for testing with SMF. (cburschka/cadence/#31)
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index adff0ee..5637636 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,12 @@ The class methods must return boolean values indicating success or failure.
It is generally recommended NOT to allow account creation, account deletion or
password changes, and instead to simply return FALSE in these methods.
+If you wish to use the `session` plugin with your bridge, you will also need to
+implement a function named {xyz}_session(). This function takes no arguments.
+It is called in a non-CLI context, and should return the username of the
+currently logged-in user who made the web request, or `FALSE` if no user
+is logged in.
+
License
-------