readme update

Author: quentinblampey

README.md

@@ -1,5 +1,13 @@
 # SpatialData to Xenium Explorer
 
+[![PyPI](https://img.shields.io/pypi/v/spatialdata_xenium_explorer.svg)](https://pypi.org/project/spatialdata_xenium_explorer)
+[![Downloads](https://static.pepy.tech/badge/spatialdata_xenium_explorer)](https://pepy.tech/project/spatialdata_xenium_explorer)
+[![Docs](https://img.shields.io/badge/docs-mkdocs-blue)](https://quentinblampey.github.io/spatialdata_xenium_explorer/)
+![Build](https://github.com/quentinblampey/spatialdata_xenium_explorer/workflows/ci/badge.svg)
+[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
+[![License](https://img.shields.io/pypi/l/spatialdata_xenium_explorer.svg)](https://github.com/quentinblampey/spatialdata_xenium_explorer/blob/master/LICENSE)
+[![Imports: isort](https://img.shields.io/badge/imports-isort-blueviolet)](https://pycqa.github.io/isort/)
+
 Converting any [`SpatialData`](https://github.com/scverse/spatialdata) object into files that can be open by the [Xenium Explorer](https://www.10xgenomics.com/support/software/xenium-explorer).
 
 > *Xenium Explorer* is a registered trademark of 10x Genomics
@@ -12,14 +20,16 @@ pip install spatialdata_xenium_explorer
 
 ## Usage
 
-You can use our [CLI](TODO) or [API](TODO), see examples below. It will create up to 6 files, among which a file called `experiment.xenium`. Double-click on this file to open it on the [Xenium Explorer](https://www.10xgenomics.com/support/software/xenium-explorer/downloads) (make sure you have the latest version of the software).
+You can use our CLI or API, see examples below. It will create up to 6 files, among which a file called `experiment.xenium`. Double-click on this file to open it on the [Xenium Explorer](https://www.10xgenomics.com/support/software/xenium-explorer/downloads) (make sure you have the latest version of the software).
 
 ### CLI
 
 ```sh
 spatialdata_xenium_explorer write /path/to/sdata.zarr
 ```
 
+Check [our documentation](https://quentinblampey.github.io/spatialdata_xenium_explorer/cli) for more details.
+
 ### API
 
 ```python
@@ -31,6 +41,8 @@ sdata = spatialdata.read_zarr("...")
 spatialdata_xenium_explorer.write("/path/to/directory", sdata, image_key, shapes_key, points_key, gene_column)
 ```
 
-## Future improvements and contributions
+Check [our documentation](https://quentinblampey.github.io/spatialdata_xenium_explorer/api) for more details.
+
+## Contributing
 
 This package is still in early development. Contributions are welcome (new issues, pull requests, ...).

pyproject.toml

@@ -1,9 +1,22 @@
 [tool.poetry]
 name = "spatialdata_xenium_explorer"
-version = "0.1.0"
+version = "0.1.1"
 description = "Converting any SpatialData object into files that can be open by the Xenium Explorer"
+documentation = "https://quentinblampey.github.io/spatialdata_xenium_explorer/"
+homepage = "https://quentinblampey.github.io/spatialdata_xenium_explorer/"
+repository = "https://github.com/quentinblampey/spatialdata_xenium_explorer"
 authors = ["Quentin Blampey <quentin.blampey@gmail.com>"]
 packages = [{ include = "spatialdata_xenium_explorer" }]
+license = "BSD-3-Clause"
+readme = "README.md"
+classifiers = [
+  "License :: OSI Approved :: BSD License",
+  "Operating System :: MacOS :: MacOS X",
+  "Operating System :: POSIX :: Linux",
+  "Operating System :: Microsoft :: Windows",
+  "Programming Language :: Python :: 3",
+  "Topic :: Scientific/Engineering",
+]
 
 [tool.poetry.scripts]
 spatialdata_xenium_explorer = "spatialdata_xenium_explorer.main:app"