readme 👀

Cargo.toml

@@ -2,7 +2,10 @@
 name = "chaiwala"
 version = "0.1.1"
 edition = "2021"
-
+authors = ["Sho Kaneko <kanekoshoyu@gmail.com>"]
+description = "Endpoints for Kucoin Arbitrage Deployment"
+repository = "https://github.com/kanekoshoyu/chaiwala"
+license = "MIT"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]

README.md

@@ -1,2 +1,9 @@
 # chaiwala
-endpoints for kucoin-arbitrage deployment
+[![](https://img.shields.io/crates/v/chaiwala)](https://crates.io/crates/chaiwala)
+[![](https://img.shields.io/docsrs/chaiwala)](https://docs.rs/chaiwala)
+[![](https://img.shields.io/github/license/kanekoshoyu/chaiwala)](https://github.com/kanekoshoyu/chaiwala/blob/master/LICENSE)  
+Endpoints for kucoin-arbitrage deployment, in event-driven async Rust
+
+### Introduction
+Having the perfect algorithm and software architecture is not enough for algo-trading. A low latency network environment is needed to properly place order, which highlights the need of deployment to the cloud.  
+As of now, Kucoin API has the lowest latency at AWS east japan, which suggests deployment over ECS or similar services using docker. To facilitate the effective remote debug reports and performance reports, this repo was set up to experiment hosting a webserver in event-driven async rust.