chore: add documentation links [ci skip]

cdbattags · Oct 4, 2020 · 0624dbe · 0624dbe
1 parent 7408e37
commit 0624dbe
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -5,7 +5,9 @@ authors = ["Michele Lacchia <michelelacchia@gmail.com>"]
 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
@@ -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