diff --git a/README.md b/README.md index b66eb8d..a02387e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,23 @@

quaxed

Pre-Quaxify'ed JAX

+

+ PyPI: quaxed + PyPI versions: quaxed + ReadTheDocs + quaxed license +

+

+ CI status + ReadTheDocs + codecov + ruff + ruff + pre-commit +

+ +--- + `Quaxed` wraps [jax](https://jax.readthedocs.io/en/latest/) libraries (using [`quax`](https://docs.kidger.site/quax/)) to enable using those libraries with custom array-ish objects, not only jax arrays. @@ -18,7 +35,7 @@ pip install quaxed ## Documentation -[![Documentation Status][rtd-badge]][rtd-link] +[![Read The Docs](https://img.shields.io/badge/read_docs-here-orange)](https://unxt.readthedocs.io/en/) ## Quick Start @@ -42,7 +59,11 @@ Quantity['area'](Array(4, dtype=int64, weak_type=True), unit='km2') ## Development [![Actions Status][actions-badge]][actions-link] -[![Codecov][codecov-badge]][codecov-link] +[![Documentation Status][rtd-badge]][rtd-link] +[![codecov][codecov-badge]][codecov-link] +[![SPEC 0 — Minimum Supported Dependencies][spec0-badge]][spec0-link] +[![pre-commit][pre-commit-badge]][pre-commit-link] +[![ruff][ruff-badge]][ruff-link] We welcome contributions! @@ -59,11 +80,17 @@ please consider citing this work. [actions-link]: https://github.com/GalacticDynamics/quaxed/actions [codecov-badge]: https://codecov.io/gh/GalacticDynamics/quaxed/graph/badge.svg?token=9G19ONVD3U [codecov-link]: https://codecov.io/gh/GalacticDynamics/quaxed +[pre-commit-badge]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit +[pre-commit-link]: https://pre-commit.com [pypi-link]: https://pypi.org/project/quaxed/ [pypi-platforms]: https://img.shields.io/pypi/pyversions/quaxed [pypi-version]: https://img.shields.io/pypi/v/quaxed [rtd-badge]: https://readthedocs.org/projects/quaxed/badge/?version=latest [rtd-link]: https://quaxed.readthedocs.io/en/latest/?badge=latest +[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json +[ruff-link]: https://docs.astral.sh/ruff/ +[spec0-badge]: https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038 +[spec0-link]: https://scientific-python.org/specs/spec-0000/ [zenodo-badge]: https://zenodo.org/badge/732262318.svg [zenodo-link]: https://zenodo.org/doi/10.5281/zenodo.10850521