From 9517aeb543bc7e34b18786b15631c9c74cc277d0 Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Sat, 29 Feb 2020 22:43:57 +0200
Subject: [PATCH] More documentation.

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/README.md b/README.md
index 823d33f..4bee4bf 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,44 @@
 
 A Flask and Celery demo app.
 
+## Requirements
+
+- Docker
+- Docker Compose
+
+## Usage
+
+Start the application and rebuild if necessary:
+
+```
+docker-compose up --build
+```
+
+Stop the application:
+
+```
+docker-compose down
+```
+
+Stop the application and delete volumes (starting from scratch):
+
+```
+docker-compose down -v
+```
+
+Start a Python interperter inside the Flask web server container:
+
+```
+docker-compose exec server python
+```
+
+Post a message to the Flask web server for the Celery worker to output:
+
+```
+curl -H "Content-Type: application/json" -X post -d '{"message": "foo"}' http://localhost:8080/log
+```
+
+
 ## License
 
 This software is licensed under the MIT license (see `LICENSE.txt`).
-- 
GitLab