diff --git a/README.md b/README.md index ae5b09c..ce98011 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ +[![PyPI Latest Release](https://img.shields.io/pypi/v/datalogs)](https://pypi.org/project/datalogs/) +[![PyPI Python Versions](https://img.shields.io/pypi/pyversions/datalogs)](https://pypi.org/project/datalogs/) +[![License](https://img.shields.io/pypi/l/paramdb)](https://github.com/PainterQubits/datalogs/blob/main/LICENSE) +[![CI](https://github.com/PainterQubits/datalogs/actions/workflows/ci.yml/badge.svg)](https://github.com/PainterQubits/datalogs/actions/workflows/ci.yml) +[![Documentation Status](https://readthedocs.org/projects/datalogs/badge/?version=latest)](https://datalogs.readthedocs.io) + Python package for logging data from scientific experiments. @@ -13,14 +19,14 @@ Python package for logging data from scientific experiments. Install the latest version of DataLogs using pip: ``` -pip install -U datalogs --extra-index-url https://painterqubits.github.io/datalogs/releases +pip install -U datalogs ``` To install along with [ParamDB] for support for tagging logs with the latest commit ID, DataLogs can be installed with the `paramdb` extra: ``` -pip install -U "datalogs[paramdb]" --extra-index-url https://painterqubits.github.io/datalogs/releases +pip install -U "datalogs[paramdb]" ``` [ParamDB]: https://paramdb.readthedocs.io/en/stable/