add readme content

2024-05-22 23:06:08 -06:00 · 2024-05-22 23:06:08 -06:00 · 72340b2d0e
commit 72340b2d0e
parent a803693dde
1 changed files with 12 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,13 @@
 # teufa
+
+תעופה (aviation)
+
+teufa is an open-source virtual airline platform written in Python.
+
+## Getting started
+
+teufa should be run with Docker:
+
+```
+docker run -it ghcr.io/brosner/teufa:main
+```