Add quickstart guide

teambtcmap · Oct 3, 2024 · 0a9f4ce · 0a9f4ce
1 parent bbf7ead
commit 0a9f4ce
Showing 1 changed file with 22 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,22 @@
-TODO
+## Quickstart
+
+1. Download `btcmap-cli` binary
+
+```bash
+sudo curl --output /usr/local/bin/btcmap-cli \
+     --location \
+     https://github.com/teambtcmap/mapctl/releases/download/preview/btcmap-cli && \
+     sudo chmod +x /usr/local/bin/btcmap-cli
+```
+
+2. Login with your admin password
+
+```bash
+btcmap-cli login <password>
+```
+
+3. Check `help` to see all available actions
+
+```bash
+btcmap-cli help
+```