docs: add important note about using GitHub version of plotlars due t…

…o polars issue
alceal · Oct 12, 2024 · 0e8c027 · 0e8c027
1 parent ca0a5c5
commit 0e8c027
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "plotlars"
-version = "0.5.0"
+version = "0.5.2"
 authors = ["Alberto Cebada Aleu <[email protected]>"]
 edition = "2021"
 rust-version = "1.80.1"

diff --git a/README.md b/README.md
@@ -11,6 +11,23 @@
     </a>
 </p>
 
+> ## <span style="color: red; font-weight: bold;">⚠️ Important Note</span>
+>
+> **Due to an issue in the `polars` crate, you must install the `plotlars` crate
+> from its GitHub repository to ensure proper functionality.**
+>
+> To include the GitHub version of `plotlars` with the fix in your project, add the following line to your `Cargo.toml` file, specifying the `fix/polars-issue` branch:
+>
+> ```toml
+> [dependencies]
+> plotlars = { git = "https://github.com/user/plotlars", branch = "fix/polars-issue" }
+> ```
+>
+> If you’re using a Rust notebook, you can include the dependency using:
+>```
+> :dep plotlars = { git = "https://github.com/alceal/plotlars", branch = "fix/polars-issue" }
+> ```
+
 Plotlars is a versatile Rust library that acts as a wrapper around the Plotly
 crate, bridging the gap between the powerful Polars data analysis library and
 Plotly. It simplifies the process of creating visualizations from data frames,