Skip to content

Update readme for consistency across tskit-dev #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 1, 2025
Merged

Update readme for consistency across tskit-dev #214

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# kastore


[![CircleCI](https://circleci.com/gh/tskit-dev/kastore/tree/main.svg?style=svg)](https://circleci.com/gh/tskit-dev/kastore/tree/main) [![codecov](https://codecov.io/gh/tskit-dev/kastore/branch/main/graph/badge.svg)](https://codecov.io/gh/tskit-dev/kastore)
[![License](https://img.shields.io/github/license/tskit-dev/kastore)](https://github.com/tskit-dev/kastore/blob/main/LICENSE) [![PyPI version](https://img.shields.io/pypi/v/kastore.svg)](https://pypi.org/project/kastore/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/kastore.svg)](https://pypi.org/project/kastore/) [![Binary wheels](https://github.com/tskit-dev/kastore/actions/workflows/wheels.yml/badge.svg)](https://github.com/tskit-dev/kastore/actions/workflows/wheels.yml) [![Tests](https://github.com/tskit-dev/kastore/actions/workflows/tests.yml/badge.svg)](https://github.com/tskit-dev/kastore/actions/workflows/tests.yml) [![codecov](https://codecov.io/gh/tskit-dev/kastore/branch/main/graph/badge.svg)](https://codecov.io/gh/tskit-dev/kastore)

A simple key-array store for read-only numerical data used in [tskit](https://github.com/tskit-dev/tskit).
Please see the [documentation](https://kastore.readthedocs.io/en/latest/) for more information.
Please see the documentation ([stable](https://kastore.readthedocs.io/en/stable/) • [latest](https://kastore.readthedocs.io/en/latest/)) for more information.

## Installation (Python)

```bash
python -m pip install kastore
# or
conda install -c conda-forge kastore
```

For C library usage and build instructions, see the documentation.
Loading