Draft quick README for the command-line

CardanoSolutions · Sep 19, 2024 · 3035e56 · 3035e56
1 parent e489996
commit 3035e56
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/cli/README.md b/cli/README.md
@@ -0,0 +1,24 @@
+# ZhuLi
+
+> [!NOTE]
+> A companion command-line tool for managing a hot/cold DRep setup.
+
+## Installing
+
+### Linux / MacOS
+
+```console
+❯ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/CardanoSolutions/zhuli/releases/download/0.0.1/zhuli-installer.sh | sh
+```
+
+### Windows
+
+```console
+❯ powershell -c "irm https://github.com/CardanoSolutions/zhuli/releases/download/0.0.1/zhuli-installer.ps1 | iex"
+```
+
+## Getting Started
+
+```console
+❯ zhuli --help
+```