diff --git a/README.md b/README.md index 823d33fefed4b97b9d85ebb5bf241a1998785bb6..4bee4bf689a23a4294a623f99261cb4c0ea8f3d6 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`).