Move readme to index (#5)

Author: artememelin

Project.toml

@@ -1,6 +1,6 @@
 name = "CcyConv"
 uuid = "6414a262-d954-4101-8ae8-e45873c55136"
-version = "1.0.0"
+version = "1.0.1"
 
 [deps]
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"

README.md

@@ -53,15 +53,20 @@ using CcyConv
 
 crypto = FXGraph()
 
-push!(crypto, Price("ADA",  "USDT", 0.5911))
-push!(crypto, Price("ADA",  "BTC",  0.00000892))
-push!(crypto, Price("BTC",  "ETH",  19.9089))
-push!(crypto, Price("USDT", "ETH",  0.0003))
-push!(crypto, Price("ETH",  "BNB",  5.9404))
-push!(crypto, Price("USDT", "XRP",  1.6929))
-push!(crypto, Price("XRP",  "BNB",  NaN))
-push!(crypto, Price("USDC", "XRP",  1.6920))
-push!(crypto, Price("ADA",  "USDC", 0.5909))
+append!(
+    crypto,
+    [
+        Price("ADA", "USDT", 0.5911),
+        Price("ADA", "BTC", 0.00000892),
+        Price("BTC", "ETH", 19.9089),
+        Price("USDT", "ETH", 0.0003),
+        Price("ETH", "BNB", 5.9404),
+        Price("USDT", "XRP", 1.6929),
+        Price("XRP", "BNB", NaN),
+        Price("USDC", "XRP", 1.6920),
+        Price("ADA", "USDC", 0.5909),
+    ],
+)
 
 conv = conv_a_star(crypto, "ADA", "BNB")
 

docs/src/index.md

@@ -2,7 +2,19 @@
 
 CcyConv is a Julia package for performing currency conversions. It allows for direct and multi-step conversions using the latest exchange 💱 rates.
 
-## Quickstart
+## 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
+```
+
+To install CcyConv, simply use the Julia package manager:
+
+```julia
+] add CcyConv
+```
+
+## Usage
 
 Here's how you can find a conversion path from `ADA` to `BNB`:
 
@@ -35,15 +47,20 @@ using CcyConv
 
 crypto = FXGraph()
 
-push!(crypto, Price("ADA",  "USDT", 0.5911))
-push!(crypto, Price("ADA",  "BTC",  0.00000892))
-push!(crypto, Price("BTC",  "ETH",  19.9089))
-push!(crypto, Price("USDT", "ETH",  0.0003))
-push!(crypto, Price("ETH",  "BNB",  5.9404))
-push!(crypto, Price("USDT", "XRP",  1.6929))
-push!(crypto, Price("XRP",  "BNB",  NaN))
-push!(crypto, Price("USDC", "XRP",  1.6920))
-push!(crypto, Price("ADA",  "USDC", 0.5909))
+append!(
+    crypto,
+    [
+        Price("ADA", "USDT", 0.5911),
+        Price("ADA", "BTC", 0.00000892),
+        Price("BTC", "ETH", 19.9089),
+        Price("USDT", "ETH", 0.0003),
+        Price("ETH", "BNB", 5.9404),
+        Price("USDT", "XRP", 1.6929),
+        Price("XRP", "BNB", NaN),
+        Price("USDC", "XRP", 1.6920),
+        Price("ADA", "USDC", 0.5909),
+    ],
+)
 
 conv = conv_a_star(crypto, "ADA", "BNB")
 
@@ -56,3 +73,63 @@ julia> conv_chain(conv)
  Price("USDT", "ETH",  0.0003)
  Price("ETH",  "BNB",  5.9404)
 ```
+
+The package lets you to set up a directed graph containing currencies as vertices and convert rates as edges. The graph can fill the missing data from anywhere and directly during the running conversion path calculation.
+
+```julia
+using CcyConv
+using CryptoAPIs
+
+struct MyCtx <: CcyConv.AbstractCtx
+    prices::Dict{String,Float64}
+
+    MyCtx() = new(Dict{String,Float64}())
+end
+
+struct ExSymbol <: CcyConv.AbstractPrice
+    base_asset::String
+    quote_asset::String
+    symbol::String
+end
+
+function CcyConv.from_asset(x::ExSymbol)::String
+    return x.base_asset
+end
+
+function CcyConv.to_asset(x::ExSymbol)::String
+    return x.quote_asset
+end
+
+function CcyConv.price(ctx::MyCtx, x::ExSymbol)::Float64
+    return get!(ctx.prices, x.symbol) do
+        try
+            CryptoAPIs.Binance.Spot.avg_price(; symbol = x.symbol).result.price
+        catch
+            NaN
+        end
+    end
+end
+
+my_graph = FXGraph()
+my_ctx = MyCtx()
+
+append!(
+    my_graph,
+    [
+        ExSymbol("ADA",  "BTC",  "ADABTC"),
+        ExSymbol("BTC",  "USDT", "BTCUSDT"),
+        ExSymbol("PEPE", "USDT", "PEPEUSDT"),
+        ExSymbol("EOS",  "USDT", "EOSUSDT"),
+    ],
+)
+
+my_conv = (to, from) -> conv_value(my_graph(my_ctx, CcyConv.a_star_alg, to, from))
+
+julia> @time my_conv("ADA", "EOS")
+  4.740000 seconds (1.80 M allocations: 120.606 MiB, 0.52% gc time, 14.55% compilation time)
+0.6004274502578457
+
+julia> @time my_conv("ADA", "EOS")
+  0.000130 seconds (46 allocations: 2.312 KiB)
+0.6004274502578457
+```