aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Mudrák <david@moodle.com>2017-09-28 14:18:38 +0200
committerDavid Mudrák <david@moodle.com>2017-09-28 14:18:38 +0200
commit93b875497d8e655e874a4d1d67d5998ac9e4443f (patch)
tree78998583fd33690d416554333d8363f1d0f09540
parenta94afb1febd3f982a5e1ec0bedb1cb4985023496 (diff)
downloadAuthMinetest-93b875497d8e655e874a4d1d67d5998ac9e4443f.tar.gz
AuthMinetest-93b875497d8e655e874a4d1d67d5998ac9e4443f.tar.bz2
AuthMinetest-93b875497d8e655e874a4d1d67d5998ac9e4443f.zip
Improve README
-rw-r--r--README.md48
1 files changed, 46 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9f319e4..fcddb68 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,46 @@
-# mediawiki-authmoodle
-Extension for MediaWiki allowing to authenticate users against Moodle database via mobile app services
+# AuthMoodle
+
+Extension for MediaWiki allowing to authenticate users against Moodle database via mobile app service.
+
+## Requirements:
+
+* MediaWiki 1.27+
+* Moodle 3.1+ with mobile app service enabled
+
+## Installation and setup
+
+Clone / unzip into your MediaWiki's extension/AuthMoodle/ folder.
+
+Configure your MediaWiki authentication manager to use this extension as the
+primary authentication provider:
+
+ wfLoadExtension( 'AuthMoodle' );
+
+ $wgAuthManagerAutoConfig['primaryauth'] = [
+ MediaWiki\Auth\MoodlePasswordPrimaryAuthenticationProvider::class => [
+ 'class' => MediaWiki\Auth\MoodlePasswordPrimaryAuthenticationProvider::class,
+ 'args' => [
+ [
+ 'moodleUrl' => 'https://your.moodle.url',
+ ]
+ ],
+ 'sort' => 0,
+ ],
+ ];
+
+## Copying
+
+Copyright 2017 David Mudrák <david@moodle.org>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.