summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristoph Burschka2014-01-15 23:52:05 +0100
committerChristoph Burschka2014-01-15 23:57:44 +0100
commit80085ee11cefde6a9a6bf74cc3efb1bf68063d54 (patch)
tree559fb4c307c718d9995555f2b3c62dfe73057b74
parentWhitespace cleanup (remove tabs) (diff)
downloadejabberd-auth-php-80085ee11cefde6a9a6bf74cc3efb1bf68063d54.tar.gz
Formatting of README headings.
-rw-r--r--README.md17
1 files changed, 11 insertions, 6 deletions
diff --git a/README.md b/README.md
index d6fa8be..adff0ee 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,10 @@
-## ABOUT
+ejabberd-auth-php
+=================
This is a collection of bridges allowing an ejabberd XMPP server to use a locally installed PHP-based CMS for external authentication.
-## FEATURES
+Features
+--------
Currently implemented bridges:
@@ -14,7 +16,8 @@ Currently implemented bridges:
Potential candidates for further bridges are WordPress, MediaWiki, Joomla! and Moodle.
-## EXTENDING
+Extending
+---------
In order to create a new plugin named {xyz}, you will need the following:
@@ -28,7 +31,8 @@ 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.
-## LICENSE
+License
+-------
The core project, without plugins, may be distributed or modified under the
under the terms of the GNU General Public License, version 2 or later.
@@ -44,10 +48,11 @@ license as the core project.
GPL v2: http://www.gnu.org/licenses/gpl-2.0.txt
GPL v3: http://www.gnu.org/licenses/gpl-3.0.txt
-## SUPPORT
+Support
+-------
I will not be able to offer support or reliable maintenance for this software,
-or any of its plugins. Functionality may be change without notice. This software
+or any of its plugins. Functionality may be changed without notice. This software
is (for now) indefinitely in pre-release mode, and there are no current plans
for a stable release.