Skip to content

Commit

Permalink
docs: add codecov to readme (#91)
Browse files Browse the repository at this point in the history
* docs: add codecov to readme

Signed-off-by: Nathaniel Starkman <nstarman@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
nstarman and pre-commit-ci[bot] authored Sep 26, 2024
1 parent 1af07e2 commit 4fe61ca
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<h1 align='center'> quaxed </h1>
<h2 align="center">Pre-<code>Quaxify</code>'ed <code>JAX</code></h2>
<h3 align="center">Pre-<code>Quaxify</code>'ed <code>JAX</code></h3>

`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.

## Installation

[![PyPI platforms][pypi-platforms]][pypi-link]
[![PyPI version][pypi-version]][pypi-link]
[![PyPI platforms][pypi-platforms]][pypi-link]

<!-- [![Conda-Forge][conda-badge]][conda-link] -->

Expand Down Expand Up @@ -42,6 +42,7 @@ Quantity['area'](Array(4, dtype=int64, weak_type=True), unit='km2')
## Development

[![Actions Status][actions-badge]][actions-link]
[![Codecov][codecov-badge]][codecov-link]

We welcome contributions!

Expand All @@ -56,6 +57,8 @@ please consider citing this work.
<!-- prettier-ignore-start -->
[actions-badge]: https://github.com/GalacticDynamics/quaxed/workflows/CI/badge.svg
[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
[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
Expand Down

0 comments on commit 4fe61ca

Please sign in to comment.