From a473a145ac74175891f658a8b90b250bdc86c974 Mon Sep 17 00:00:00 2001 From: Max Jones <14077947+maxrjones@users.noreply.github.com> Date: Wed, 18 Mar 2026 11:19:21 -0400 Subject: [PATCH] Update README to markdown with working badges --- README.md | 9 +++++++++ pyproject.toml | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..c6bb9d82 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Numcodecs + +Numcodecs is a Python package providing buffer compression and transformation +codecs for use in data storage and communication applications. + +[![Docs](https://readthedocs.org/projects/numcodecs/badge/?version=latest)](https://numcodecs.readthedocs.io/en/latest/?badge=latest) +[![Tests](https://github.com/zarr-developers/numcodecs/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/zarr-developers/numcodecs/actions/workflows/ci.yaml) +[![Wheels](https://github.com/zarr-developers/numcodecs/actions/workflows/wheel.yaml/badge.svg?branch=main)](https://github.com/zarr-developers/numcodecs/actions/workflows/wheel.yaml) +[![Codecov](https://codecov.io/gh/zarr-developers/numcodecs/branch/main/graph/badge.svg)](https://codecov.io/gh/zarr-developers/numcodecs) diff --git a/pyproject.toml b/pyproject.toml index a47600dc..190b8e18 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -13,7 +13,7 @@ name = "numcodecs" description = """ A Python package providing buffer compression and transformation codecs \ for use in data storage and communication applications.""" -readme = "README.rst" +readme = "README.md" dependencies = ["numpy>=1.24", "typing_extensions"] requires-python = ">=3.11" dynamic = [