Add install instructions to front page

BioImageTools · Nov 22, 2024 · 49ff2c9 · 49ff2c9
1 parent 0e7716a
commit 49ff2c9
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -3,6 +3,17 @@
 This is a Python package that provides a Python object representation of an OME-zarr dataset.
 It aims to be a reference implementation of the OME-zarr specification.
 
+## Installing
+
+Currently this package is only available in the GitHub repo.
+Install it using:
+
+```sh
+pip install git+https://github.com/BioImageTools/ome-zarr-models-py.git@main
+```
+
+When we do a first release, it will be available on PyPI and conda-forge.
+
 ## Design
 
 This package is designed with the following guiding principles: