chore: add more info to the readme

frectonz · Oct 5, 2024 · 5a995e5 · 5a995e5
1 parent f2e4ef4
commit 5a995e5
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,21 @@
 # Octopod
+
+A UI for Docker Registries
+
+```
+A UI for Docker Registries
+
+Usage: octopod [OPTIONS] --registry-url <REGISTRY_URL>
+
+Options:
+      --address <ADDRESS>
+          The address to bind to [env: ADDRESS=] [default: 127.0.0.1:3030]
+      --registry-url <REGISTRY_URL>
+          Registry URL to connect to. Example [http://127.0.0.1:3030] [env: REGISTRY_URL=]
+      --registry-credentials <REGISTRY_CREDENTIALS>
+          Registry username and password separated with a colon. Example [username:password] [env: REGISTRY_CREDENTIALS=]
+  -h, --help
+          Print help
+  -V, --version
+          Print version
+```