diff --git a/Cargo.toml b/Cargo.toml index 936a73f..a25099b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,12 @@ [package] name = "msyrs" -version = "0.0.1" edition = "2021" +version = "0.0.1" +readme = "README.md" + +[package.metadata.docs] +rustdoc = ["--cfg", "doc"] + [dependencies] reqwest = { version = "0.12.9", features = ["blocking", "json"] } diff --git a/README.md b/README.md index 1235a9c..45f8373 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,19 @@ A Rust implementation of the [Macrosynergy Python Package](https://github.com/ma ## Status -- Docs - - [x] Building - - [ ] written? - Download - - [x] OAuth workflow - - [x] Heartbeat - [x] Get Catalogue - [x] Get Generic DQ Time Series - - [x] Get JPMaQS Indicators (formatted as array) - [x] Get JPMaQS Indicators as Polars DataFrame - - [x] Add QDF option - [ ] Save to disk functionality - [x] Hacky iterative method - [ ] Non-hacky way to save to disk - Utils - [ ] Reduce DF - - [ ] Reduce DF by ticker - [ ] Apply Blacklist - - [ ] Get Blacklist - - [ ] Apply Slip - + - [ ] Update DF - Panel - [ ] Historic Volatility diff --git a/src/lib.rs b/src/lib.rs index 674b799..b3529ae 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1 +1,3 @@ +#![doc = include_str!("../README.md")] + pub mod download;