Skip to content

Commit 456a3e1

Browse files
authored
Update README to markdown with working badges (#827)
1 parent c5f1af7 commit 456a3e1

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Numcodecs
2+
3+
Numcodecs is a Python package providing buffer compression and transformation
4+
codecs for use in data storage and communication applications.
5+
6+
[![Docs](https://readthedocs.org/projects/numcodecs/badge/?version=latest)](https://numcodecs.readthedocs.io/en/latest/?badge=latest)
7+
[![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)
8+
[![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)
9+
[![Codecov](https://codecov.io/gh/zarr-developers/numcodecs/branch/main/graph/badge.svg)](https://codecov.io/gh/zarr-developers/numcodecs)

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ name = "numcodecs"
1313
description = """
1414
A Python package providing buffer compression and transformation codecs \
1515
for use in data storage and communication applications."""
16-
readme = "README.rst"
16+
readme = "README.md"
1717
dependencies = ["numpy>=1.24", "typing_extensions"]
1818
requires-python = ">=3.11"
1919
dynamic = [

0 commit comments

Comments
 (0)