aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fl.fischer@fau.de>2021-01-09 14:13:44 +0100
committerFlorian Fischer <florian.fl.fischer@fau.de>2021-01-09 14:13:44 +0100
commit3c652f9fe7b53bcd7d9d38b37b6640d41283bbe5 (patch)
tree9c5c63fe2ee236a9c984996b2e8b3996ae6468ce /README.md
parent132ad1949beb6aa2f474be4ac1427e0d05ebda64 (diff)
downloadcyberschuessel-3c652f9fe7b53bcd7d9d38b37b6640d41283bbe5.tar.gz
cyberschuessel-3c652f9fe7b53bcd7d9d38b37b6640d41283bbe5.zip
Improve readme and fix link to source in webpage
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index d7d1511..135b67b 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,19 @@ Webserver implementing the word guessing game Saladschuessel
IDEA
----
+Cyberschuessel allows a group of players to add words to a word pool (Schuessel)
+and then draw words out of the pool.
+
+If all words are drawn from the pool the pool is refilled and the next round starts.
+
+BUILD
+----
+
+The source code for cyberschuessel can be downloaded by running
+`git clone https://muhq.space/software/cyberschuessel.git`
+
+Cyberschuessel is a python server implemented using aiohttp and aiohttp\_jinja2.
+
LICENSE
-------