Move readme to index (#33)

artememelin · web-flow · commit 40c5ef827207 · 2024-05-08T22:23:03.000+05:00
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "CryptoAPIs"
 uuid = "5e3d4798-c815-4641-85e1-deed530626d3"
-version = "0.16.1"
+version = "0.16.2"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,9 +1,21 @@
+![terminal](assets/terminal.gif)
+
 # CryptoAPIs.jl
 
 CryptoAPIs is a library written in Julia that combines API wrappers from various exchanges, simplifying access to market 💹 data.
 
-## Supported Exchange APIs
+## Installation
+If you haven't installed our [local registry](https://github.com/bhftbootcamp/Green) yet, do that first:
+```
+] registry add https://github.com/bhftbootcamp/Green.git
+```
 
+Then, to install CryptoAPIs, simply use the Julia package manager:
+```
+] add CryptoAPIs
+```
+
+## Supported Exchange APIs
 ```@raw html
 <html>
     <body>
@@ -89,27 +101,3 @@ CryptoAPIs is a library written in Julia that combines API wrappers from various
     </body>
 </html>
 ```
-
-## Quickstart
-
-```julia
-using CryptoAPIs
-using CryptoAPIs.Binance
-
-Binance.Spot.ticker(;
-    symbols = ["ADAUSDT", "BTCUSDT"]
-)
-
-Binance.Spot.candle(;
-    symbol = "ADAUSDT",
-    interval = Binance.Spot.Candle.M1
-)
-
-Binance.Spot.avg_price(;
-    symbol = "ADAUSDT"
-)
-
-Binance.Spot.order_book(;
-    symbol = "ADAUSDT"
-)
-```
