Commit 16fcc4b9 authored by Pierre Rudloff's avatar Pierre Rudloff
Browse files

docs(README): Add more info

parent 1529423a
......@@ -6,9 +6,21 @@ LimeSurvey plugin that exports responses to an ownCloud server
You need to put the plugin in the `plugins/` folder of your LimeSurvey instance and then enable it in the LimeSurvey admin.
## Setup
You need to install dependencies with [Composer](https://getcomposer.org/):
```bash
composer install
```
## Usage
When editing a survey, you can go in the plugin settings (at the bottom of the survey settings menu) and fill in your ownCloud credentials and a path to an existing ownCloud folder.
The plugin will then create an ODS file in that folder and update it with new responses.
The plugin will then create an Excel file in that folder and update it with new responses.
**Warning**: you should use an application password instead of your real password.
## How it works
The plugin uses the `afterSurveyComplete` hook to be triggered when a new response is complete and then uses WebDAV to connect to ownCloud and PHPExcel to create/edit the spreadsheet.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment