From cb2686f10c58fdd1c2551e7459ad89d764cf4efb Mon Sep 17 00:00:00 2001 From: HaidenRothwell <46227616+hrothwell@users.noreply.github.com> Date: Fri, 5 Jul 2024 14:09:48 -0700 Subject: [PATCH] update readme --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1bdd9b6..53327f1 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A CLI to interact with MyAnimeList's web API ## [Usage](../../wiki/Usage) -``` +``` ~ mal -h Usage: mal [OPTIONS] COMMAND [ARGS]... @@ -37,6 +37,10 @@ https://github.com/hrothwell/mal-cli ## Latest Windows native exe - Latest windows exe build can be found [here](./native-image-items/build-results) -- I am trying to only ever merge completely functional/working native-image code, but no promises this will always work. - More automated testing to come, maybe... -- Ideally get versioning setup as well +- I am trying to only ever merge completely functional/working native-image code, but no promises this will always work. Released builds should be most stable + +## Docker Image + +- application can also be run using docker image: `docker run --mount type=bind,source="$PATH_TO_MAL_CLI",target="/root/mal-cli" -p "8080:8080" "hrothwell/mal-cli:$VERSION" ` + - `PATH_TO_MAL_CLI` --> Absolute path to location of your config files as documented in the pre-requirments above +- [mal.sh](./mal.sh) is meant to be a helper script for running in this manner