Update README.md

sudospaes · Jun 14, 2024 · f96745c · f96745c
1 parent f992992
commit f96745c
Showing 1 changed file with 30 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,30 @@
-# lollipop
-a friendly and lovely cli youtube downloader.
+# lollipop 🍭
+A friendly and lovely cli youtube downloader written in typescript for Linux, MacOS, Windows.
+
+## How to run
+- Download latest version from [release](https://github.com/sudospaes/lollipop/releases)
+- Rename downloaded file to `lollipop`
+- Open terminal or cmd and run lollipop:
+  <br>
+  <br>
+  Linux/MacOS
+    ```bash
+  ./lollipop
+  ```
+  Windows
+    ```bash
+  ./lollipop.exe
+  ```
+  Type this commands for using guide:
+  <br>
+  <br>
+  Linux/MacOS
+    ```bash
+  ./lollipop help get
+  ./lollipop help down
+  ```
+  Windows
+    ```bash
+  ./lollipop.exe help get
+  ./lollipop.exe help down
+  ```