From b72a9b3441d3a55b35fba4444804017a359523ae Mon Sep 17 00:00:00 2001
From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com>
Date: Mon, 18 Nov 2024 01:03:03 +0000
Subject: [PATCH] update documentation and organization of the msyrs Rust
 library

---
 src/lib.rs | 27 +++++++++++++++++++++------
 1 file changed, 21 insertions(+), 6 deletions(-)

diff --git a/src/lib.rs b/src/lib.rs
index 7e900db..7c98e7a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,14 +1,29 @@
-#![doc = include_str!("../README.md")]
+// #![doc = include_str!("../README.md")]
+
+//! # msyrs
+//!
+//! A Rust implementation of the [Macrosynergy Python Package](https://github.com/macrosynergy/macrosynergy).
+//!
+//! ## Build and install the Python package
+//!
+//! ```bash
+//! python -m venv .venv
+//! # source .venv/bin/activate
+//! ./.venv/Scripts/activate
+//! pip install maturin
+//! maturin develop --release
+//! ```
+//!
 
 /// Documentation for the `msyrs` Python API.
 pub mod py;
 
-/// Documentation for the Rust API.
-
-
 /// Documentation for the `download` module.
 pub mod download;
+
+/// Documentation for the `utils` module.
 pub mod utils;
 
-
-pub use py::msyrs;
+/// PyO3 bindings for the `msyrs` Python API.
+#[allow(unused_imports)]
+use py::msyrs;