From bbb866413295dc9101d06e93ccefa2d68d5f9f9a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marek=20Wieiw=C3=B3rka?= <marek.wiewiorka@gmail.com>
Date: Wed, 18 Dec 2024 23:44:52 +0100
Subject: [PATCH] doc: Installation instructions

---
 .github/workflows/publish_to_pypi.yml |  1 +
 Cargo.lock                            |  2 +-
 docs/performance.md                   |  1 +
 docs/quickstart.md                    | 15 +++++++++++++++
 mkdocs.yml                            |  2 ++
 5 files changed, 20 insertions(+), 1 deletion(-)
 create mode 100644 docs/performance.md

diff --git a/.github/workflows/publish_to_pypi.yml b/.github/workflows/publish_to_pypi.yml
index 179d8ec..29287e4 100644
--- a/.github/workflows/publish_to_pypi.yml
+++ b/.github/workflows/publish_to_pypi.yml
@@ -10,6 +10,7 @@ on:
     paths-ignore:
       - 'docs/**'
       - 'benchmark/**'
+      - 'mkdocs.yml'
   pull_request:
   workflow_dispatch:
 
diff --git a/Cargo.lock b/Cargo.lock
index 8001154..a23c351 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2734,7 +2734,7 @@ checksum = "953ec861398dccce10c670dfeaf3ec4911ca479e9c02154b3a215178c5f566f2"
 
 [[package]]
 name = "polars_bio"
-version = "0.2.10"
+version = "0.2.11"
 dependencies = [
  "arrow",
  "datafusion",
diff --git a/docs/performance.md b/docs/performance.md
new file mode 100644
index 0000000..2fd9f95
--- /dev/null
+++ b/docs/performance.md
@@ -0,0 +1 @@
+TBD
\ No newline at end of file
diff --git a/docs/quickstart.md b/docs/quickstart.md
index 8c4330c..853b9bf 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -1,3 +1,18 @@
+[polars-bio](https://pypi.org/project/polars-bio/) is available on PyPI and can be installed with pip:
 ```shell
 pip install polars-bio
 ```
+There are binary versions for Linux (x86_64), MacOS (x86_64 and arm64) and Windows (x86_64).
+In case of other platforms, you can build polars-bio from source with [maturin](https://github.com/PyO3/maturin):
+```shell
+RUSTFLAGS="-Ctarget-cpu=native" maturin build --release  -m Cargo.toml
+```
+and you should see the following output:
+```shell
+Compiling polars_bio v0.2.11 (/Users/mwiewior/research/git/polars-bio)
+Finished `release` profile [optimized] target(s) in 1m 25s
+📦 Built wheel for abi3 Python ≥ 3.8 to /Users/mwiewior/research/git/polars-bio/target/wheels/polars_bio-0.2.11-cp38-abi3-macosx_11_0_arm64.whl
+
+```
+!!! note
+    Rust compiler and Cargo are required to build the package from source. [rustup](https://rustup.rs/) is the recommended way to install Rust.
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 0983540..8c79567 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -8,10 +8,12 @@ nav:
       - 🏃🏼‍♂️ Quick start: quickstart.md
       - 🔨Features: features.md
       - 📚 Tutorial: notebooks/tutorial.ipynb
+      - 🚀 Performance: performance.md
       - ⚙️ API reference: api.md
   - Quick start: quickstart.md
   - Features: features.md
   - Tutorial: notebooks/tutorial.ipynb
+  - Performance: performance.md
   - API reference: api.md
 
 plugins: