summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristoph Burschka2013-12-30 01:49:12 +0100
committerChristoph Burschka2013-12-30 01:49:12 +0100
commite1e3548260e3fe5335ce09c534b6944d2450ab37 (patch)
tree3c5114297a40ef88325d99a2b996dd723ae1f05f
parentDo not set a plugin by default. (diff)
downloadejabberd-auth-php-e1e3548260e3fe5335ce09c534b6944d2450ab37.tar.gz
Add a short description on writing new plugins.
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 80e5e6e..6c81120 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,15 @@ Currently implemented bridges:
Potential candidates for further bridges are WordPress, MediaWiki, Joomla! and Moodle.
+## EXTENDING
+
+In order to create a new plugin named <xyz>, you will need the following:
+
+* A class extending EjabberdAuthBridge and implementing its methods.
+* A file named <xyz>.module that contains the function <xyz>_init().
+* <xyz>_init() will receive its appropriate conf array in config.php.
+* <xyz>_init() must return an instance of the extended class.
+
## LICENSE
The core project, without plugins, is available under the terms of the GNU General Public License, version 2 or later.