fix: add missing colon in text

[motion.git] / README.md

diff --git a/README.md b/README.md
index 5d1390fc9b6211b0a3f4f464ab8e18296b1fbc04..fa02a3b55dff59ab9d35c2f35a0b54a5f831f4fd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,8 @@
 # Installation
-Requires 3.
+Requires Python 3 and a running PostgreSQL installation.
+
+For a productive environment use a nginx webserver.
+
 To install:
 ```
 virtualenv -p python3 .
@@ -8,6 +11,8 @@ pip install -r requirements.txt
 ```
 Then edit config.py.example into config.py with your database connection
 
+## Development and debug
+
 To debug-run linux:
 ```
 LANG=C.UTF-8 FLASK_DEBUG=1 FLASK_APP=motion.py flask run
@@ -28,11 +33,23 @@ python -m unittest tests/test_motion.py
 
 The database schema is automatically installed when the table "schema_version" does not exist and the application is started.
 
+The following user rights can be granted:
+- create: user is able to create a new motion
+- vote: user is able to vote running motions
+- cancel: user is able to cancel a running motion
+- finish: user is able to close a running motion
+- audit: user is able to see given votes of a finished motion
+
+To grant right use the following (here with vote right as example):
+- on all groups add "vote:*"
+- on one given group add "vote:group1"
+- on two given groups add "vote:group1 vote:group2"
+
 # Usage
 
 Within the motion content markdown can be used for formatting e.g. 
 * To add a line break add two lines
-* to enter a link use `[text](https//domain.tld/link)`
+* to enter a link use `[text](https://domain.tld/link)`
 
 ## Settings for nginx