From 1491bba8f673c870b138460c2da74e52edeb9c35 Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Sun, 27 Dec 2020 19:28:36 +0200
Subject: [PATCH] Convert README to rst.
It's a Python project after all.
---
README.md | 52 --------------------------------------------------
README.rst | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 56 insertions(+), 52 deletions(-)
delete mode 100644 README.md
create mode 100644 README.rst
diff --git a/README.md b/README.md
deleted file mode 100644
index 4bee4bf..0000000
--- a/README.md
+++ /dev/null
@@ -1,52 +0,0 @@
-# Waldorf
-
-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`).
-
-## Author Information
-
-Nimrod Adar, [contact me](mailto:nimrod@shore.co.il) or visit my [website](
-https://www.shore.co.il/). Patches are welcome via [`git send-email`](
-http://git-scm.com/book/en/v2/Git-Commands-Email). The repository is located
-at: <https://www.shore.co.il/git/>.
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..4b47406
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,56 @@
+Waldorf
+=======
+
+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``).
+
+Author Information
+------------------
+
+Nimrod Adar, `contact me <mailto:nimrod@shore.co.il>`__ or visit my
+`website <https://www.shore.co.il/>`__. Patches are welcome via
+```git send-email`` <http://git-scm.com/book/en/v2/Git-Commands-Email>`__.
+The repository is located at: https://www.shore.co.il/git/.
--
GitLab