From 0624dbe0a8062f5e92b3ebac3d7707fa88dc982a Mon Sep 17 00:00:00 2001 From: Michele Lacchia Date: Sun, 4 Oct 2020 10:37:39 +0200 Subject: [PATCH] chore: add documentation links [ci skip] --- Cargo.toml | 2 ++ README.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/Cargo.toml b/Cargo.toml index 96bfe24..3864a61 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,7 +5,9 @@ authors = ["Michele Lacchia "] edition = "2018" license = "ISC" +readme = "README.md" description = "A fast limit order book (LOB)" +documentation = "https://docs.rs/lobster" homepage = "https://github.com/rubik/lobster" repository = "https://github.com/rubik/lobster" keywords = ["orderbook", "order", "limit", "hft"] diff --git a/README.md b/README.md index f2de0f4..51684e7 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,8 @@ quantities are represented as unsigned 64-bit integers. If the traded instrument supports fractional prices and quantities, the conversion needs to be handled by the user. At this time, Lobster does not support negative prices. +More information can be found in the [documentation](https://docs.rs/lobster). + # Quantcup The winning quantcup submission is at the moment about 11x faster than Lobster. While Lobster can surely be improved significantly, some design choices