docs: start work on docs. todo: complete usage section with images

AstroNvim · Jul 21, 2023 · 4d1f1a1 · 4d1f1a1
1 parent 8375c11
commit 4d1f1a1
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,14 @@
 # Astrocommunity CLI
-An easier way to find and add Astrocommunity plugins.
+This repository contains the code for `astrocommunity-cli`, a community written CLI to search for and generate the code for your favorite astrocommunity plugins.
+
+## 📦 Setup
+
+Currently, we only support installing trough cargo.
+
+To install, you need to run:
+```bash
+cargo install [email protected]:Uzaaft/astrocommunity-cli
+```
+
+## 🔨 Usage
 
-Note: The CLI does not work without internet.