From f3351d4669e33beeb95cc09deda90291b4ce5dbc Mon Sep 17 00:00:00 2001
From: Benoit Alessandroni <benoit@startinblox.com>
Date: Mon, 31 Aug 2020 21:27:07 +0000
Subject: [PATCH] Update README.md
---
README.md | 67 ++++++++++++++++++++++++++++++++++++++++++-------------
1 file changed, 51 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index 790fd7d9..1b645914 100644
--- a/README.md
+++ b/README.md
@@ -159,22 +159,6 @@ On `config.json`:
A [sample fixture](https://git.startinblox.com/djangoldp-packages/djangoldp-dashboard/blob/master/djangoldp_dashboard/fixtures/sample.json) can be loaded with `./manage.py loaddata path/to/djangoldp_dashboard/fixtures/sample.json`.
-### Events
-
-Events allow to create and manage instance-level evenement. To activate them, you need:
-
-On Server: `djangoldp_event`, `djangoldp_upload` packages
-
-On `config.json`:
-
-```json
- "endpoints": {
- "events": "http://server.url/events/",
- "typeevents": "http://server.url/typeevents/",
- "uploads": "http://server.url/upload/"
- }
-```
-
### Project
Project are a private group chat including Customer and Business Provider management. To activate them, you need:
@@ -225,6 +209,57 @@ On `config.json`:
}
```
+### Events
+
+The events module includes a listing of upcoming events and the capability to create new ones.
+This module will also work inside the circles.
+To activate it, you need:
+
+On Server: `djangoldp_event`, `djangoldp_upload` packages
+
+On `config.json`:
+
+```json
+ "endpoints": {
+ "events":"http://server.url/events/",
+ "typeevents":"http://server.url/typeevents/",
+ "uploads": "http://server.url/upload/"
+ }
+```
+
+### Resources
+
+The resources module includes a listing of indexed resources and the capability to index new ones.
+This module will also work inside the circles.
+To activate it, you need:
+
+On Server: `djangoldp_resource`, `djangoldp_upload`, `djangoldp_conversation` packages
+
+On `config.json`:
+
+```json
+ "endpoints": {
+ "resources":"http://server.url/resources/",
+ "resourceskeywords":"http://server.url/keywords/",
+ "resourcestypes":"http://server.url/types/",
+ "uploads": "http://server.url/upload/"
+ }
+```
+
+### Polls
+
+The polls module allows user to create polls related (or not) to circles. To activate it, you need:
+
+On Server: `djangoldp_polls`, `djangoldp_upload`, `djangoldp_conversation` packages
+
+On `config.json`:
+
+```json
+ "endpoints": {
+ "polls":"http://server.url/polls/"
+ }
+```
+
## Use with docker
### Multi services
--
GitLab