diff --git a/README.md b/README.md index 7d72a08..5a7a5eb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# higlass-python v2 🔎 +# higlass-python 🔎 a fresh python library for [`higlass`](https://github.com/higlass/higlass) built on top of [`higlass-schema`](https://github.com/higlass/higlass-schema) and @@ -9,6 +9,13 @@ on top of [`higlass-schema`](https://github.com/higlass/higlass-schema) and ## Usage +> **Note** A release candidate for `higlass-python` v1 is now available on +> PyPI and can be installed via pip: + +```sh +pip install --pre higlass-python +``` + ```python import higlass as hg @@ -39,6 +46,9 @@ view_lock = hg.lock(view1, view2) ![Side-by-side Hi-C heatmaps, linked by pan and zoom](https://user-images.githubusercontent.com/24403730/159050305-e6a48f03-fba1-4ff7-8eee-2e9c5c40ef88.gif) + +To learn more about the new API, check out the [updated documentation](https://higlass.io/higlass-python). + ## Development **higlass-python** uses [the recommended](https://packaging.python.org/en/latest/flow/#) `hatchling` build-system,