aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Chris Lovering <[email protected]>2023-10-03 11:12:42 +0100
committerGravatar Chris Lovering <[email protected]>2023-10-03 11:12:42 +0100
commitc7a8fafff8737afbb9c9fe59ad5bf5b3400dde8f (patch)
treeb9a0bdda0037e028881769003e4600b50b56469b /README.md
parentUse 3.12 stable over rc version (diff)
Add example Docker file and docker compose files, and suggested usages
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index da7eee8..42d0455 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,8 @@
# python-poetry-base
-A base Dockerfile with poetry pre-installed
+A base Dockerfile with poetry pre-installed. Using this image as a base will allow you to forget about anything required to setup poetry within your Docker environment.
+
+Simply `COPY` your pyproject & poetry lock file into your image, and `poetry install`.
+
+virtual environments are created in `/opt/poetry/home` as to not conflict with in-project `.venv` folders that may be copied into the image if using a docker compose source code volume.
+
+See the [examples](./examples/) folder for example usage.