From a650b03f0bfd33d6efb696b9499bf57696ce4a55 Mon Sep 17 00:00:00 2001 From: evilsocket Date: Wed, 13 Nov 2024 20:45:37 +0100 Subject: [PATCH] docs: clearer info about poetry --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c74f8a..b3201ba 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,15 @@ Dreadnode command line interface. ### With Poetry: +This project is packaged for and meant to be used with the [Poetry package management tool](https://python-poetry.org/). + +To install the project dependencies: + ```bash poetry install ``` -Then enter the poetry shell: +And then enter its shell: ```bash poetry shell @@ -16,6 +20,8 @@ poetry shell ### With Docker: +Alternatively, you can build a docker image and run the CLI from a container: + ```bash docker build -t dreadnode . ```