commit e24fc07c9a8f67205715e543e5ab2417f5c9bf50
parent 0fdb7dbe7cc37683c7f5fcd63ee6ee84cc0f3d41
Author: Oscar Benedito <oscar@oscarbenedito.com>
Date: Thu, 23 Jul 2020 17:55:11 +0200
Add json example to AUN
Diffstat:
1 file changed, 17 insertions(+), 0 deletions(-)
diff --git a/atenea-updates-notifications/README.md b/atenea-updates-notifications/README.md
@@ -3,6 +3,23 @@
Very simple Python script to get notified when new documents are uploaded to
Atenea (an instance of Moodle). Makes use of a Gotify server.
+## Example `config.json`
+
+The `.json` file with the configuration looks like the following:
+
+```json
+{
+ "notification_domain": "<gotify-domain>",
+ "time_interval": 120,
+ "api_token": "<moodle-api-token>",
+ "notification_token": "<gotify-token>",
+ "course_ids": {
+ "56145": "GD",
+ "56152": "EDPS"
+ }
+}
+```
+
## License
The program is licensed under the GNU General Public License version 3
