#################
# LRS Proxy 1.0 #
#################

1. Content
==========

This plugin installs a new service in Moodle for sending xAPI (formerly TinCan API) statements to a Learning Records Store.

2. License
==========

LRS Proxy 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.

LRS Proxy 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.

The GNU General Public License is available on <http://www.gnu.org/licenses/>

3. Installation
===============

1- Download the plugin (ZIP file) from Github
2- Go to "Site administration / Plugins / Install plugins" on your Moodle website
3- Drag and drop the ZIP file from step 1
4- Click "Show more" 
5- Set the Plugin Type to "Local Plugin"
6- Click "Install plugin from the ZIP file"
7- Click "Continue"
8- Click "Upgrade Moodle database now"
9- Click "Continue"
10- Set your LRS configuration (i.e., LRS endpoint, username and password)
11- Click "Save changes"

If you want to update or change your LRS configuration, go to "Site administration / Plugins / Local plugins / LRS Proxy" on your Moodle website.

If ZIP installation is disabled, you can unzip the ZIP file to moodle/local instead of steps 3 to 7 above but you need to rename the directory as lrsproxy first.

4. Enabling the plugin
======================

1- Go to "Site administration / Advanced features" on your Moodle website
2- Check the feature "Enable web services"
3- Click "Save changes"
4- Go to "Site administration / Plugins / Web services / Manage protocols"
5- Check "Enable" for "REST protocol"
6- Click "Save changes"
7- Go to "Site administration / Plugins / Web services / External services"
8- Click "Edit" for "LRS Proxy"
9- Check "Enabled"
10- Click "Save changes"
11- Click "Authorised users" for "LRS Proxy"
12- Add a user to the list of authorised users

5. Testing
==========

1- Go to "Site administration / Plugins / Web services / Manage tokens"
2- Select a user from step 12 above
3- Select the service "LRS Proxy"
4- Click "Save changes"
5- Get token in return
6- Edit the file moodle/local/lrsproxy/client/echo.html
7- Set your Moodle website to the var "domainname"
8- Set the token from step 5 to the var "token"
9- Open the url "http://yourmoodlewebsite/moodle/local/lrsproxy/client/echo.html"
10- Check the JS console output in your browser (responseText should be "Hello World!")

6. Authors
==========

LRS Proxy has been developed by:
 - Felix J. Garcia: fgarcia@um.es
 - Luis de la Torre: ldelatorre@dia.uned.es

7. Acknowledgment
=================
Este trabajo es resultado de la estancia 19937/EE/15 financiada por la Fundación Séneca-Agencia de Ciencia y Tecnología de la Región de Murcia con cargo al Programa “Jiménez de la Espada” de Movilidad Investigadora, Cooperación e Internacionalización.