Document better the image

williamdes · williamdes · commit 5e87f68bfc47 · 2023-02-22T16:28:19.000+01:00
[ci skip]
diff --git a/README.md b/README.md
@@ -1,5 +1,27 @@
 # A docker rustpython image
 
+This is a Docker image for the RustPython project.
+It had the default feature flags + `freeze-stdlib`.
+
+You can find it on [Docker Hub](https://hub.docker.com/r/botsudo/docker-rustpython) and the sources on [GitHub](https://github.com/sudo-bot/docker-rustpython).
+
+## Pull it
+
+```sh
+docker pull botsudo/docker-rustpython:latest
+```
+
+## Example usage
+
+```sh
+# A test script
+echo -e "import json\nprint(json.dumps([{'server': [{'tls': False}]}]))" > test.py
+# Will print: [{"server": [{"tls": false}]}]
+docker run -v $PWD/test.py:/app/test.py:ro --rm botsudo/docker-rustpython:latest /app/test.py
+# See help
+docker run --rm botsudo/docker-rustpython:latest --help
+```
+
 ## Is my architecture supported ?
 
 We support as much as possible, the list is:
