diff --git a/README.md b/README.md index efffaeaac..1009ce262 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ +[![PyPI version](https://badge.fury.io/py/uproot.svg)](https://pypi.org/project/uproot) +[![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/uproot)](https://github.com/conda-forge/uproot-feedstock) +[![Python 3.5‒3.9](https://img.shields.io/badge/Python-3.5%E2%80%923.9-blue)](https://www.python.org) +[![BSD-3 Clause License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) +[![Test build](https://img.shields.io/github/workflow/status/scikit-hep/uproot4/Test%20build?label=CI)](https://github.com/scikit-hep/uproot4/actions?query=workflow%3A%22Test+build%22) +[![Deploy to PyPI](https://img.shields.io/github/workflow/status/scikit-hep/uproot4/Deploy%20to%20PyPI?label=CD)](https://github.com/scikit-hep/uproot4/actions?query=workflow%3A%22Deploy+to+PyPI%22) + [![Scikit-HEP](https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg)](https://scikit-hep.org/) [![NSF-1836650](https://img.shields.io/badge/NSF-1836650-blue.svg)](https://nsf.gov/awardsearch/showAward?AWD_ID=1836650) [![DOI 10.5281/zenodo.3952728](https://zenodo.org/badge/DOI/10.5281/zenodo.3952728.svg)](https://doi.org/10.5281/zenodo.3952728) -[![Python 3.5‒3.9](https://img.shields.io/badge/Python-3.5%E2%80%923.9-blue)](https://www.python.org) -[![BSD-3 Clause License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) -[![Latest version](https://img.shields.io/github/v/release/scikit-hep/uproot4?color=blue&label=Uproot)](https://github.com/scikit-hep/uproot4/releases/latest) +[![Documentation](https://img.shields.io/badge/docs-online-success)](https://uproot.readthedocs.io/) +[![Gitter](https://img.shields.io/badge/chat-online-success)](https://gitter.im/Scikit-HEP/uproot) Uproot is a reader and a writer of the [ROOT file format](https://root.cern/) using only Python and Numpy. Unlike the standard C++ ROOT implementation, Uproot is only an I/O library, primarily intended to stream data into machine learning libraries in Python. Unlike PyROOT and root_numpy, Uproot does not depend on C++ ROOT. Instead, it uses Numpy to cast blocks of data from the ROOT file as Numpy arrays. diff --git a/docs-sphinx/index.rst b/docs-sphinx/index.rst index e65498b7b..d738ede06 100644 --- a/docs-sphinx/index.rst +++ b/docs-sphinx/index.rst @@ -51,11 +51,42 @@ :alt: Uproot :target: https://github.com/scikit-hep/uproot4 +.. role:: raw-html(raw) + :format: html + |br| +:raw-html:`

` + +.. image:: https://badge.fury.io/py/uproot.svg + :alt: PyPI version + :target: https://pypi.org/project/uproot + +.. image:: https://img.shields.io/conda/vn/conda-forge/uproot + :alt: Conda-Forge + :target: https://github.com/conda-forge/uproot-feedstock + +.. image:: https://img.shields.io/badge/Python-3.5%E2%80%923.9-blue + :alt: Python 3.5‒3.9 + :target: https://www.python.org + +.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg + :alt: BSD-3 Clause License + :target: https://opensource.org/licenses/BSD-3-Clause + +.. image:: https://img.shields.io/github/workflow/status/scikit-hep/uproot4/Test%20build?label=CI + :alt: Test build + :target: https://github.com/scikit-hep/uproot4/actions?query=workflow%3A%22Test+build%22 + +.. image:: https://img.shields.io/github/workflow/status/scikit-hep/uproot4/Deploy%20to%20PyPI?label=CD + :alt: Deploy to PyPI + :target: https://github.com/scikit-hep/uproot4/actions?query=workflow%3A%22Deploy+to+PyPI%22 + +:raw-html:`

` + .. image:: https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg :alt: Scikit-HEP - :target: https://scikit-hep.org + :target: https://scikit-hep.org/ .. image:: https://img.shields.io/badge/NSF-1836650-blue.svg :alt: NSF-1836650 @@ -65,13 +96,15 @@ :alt: DOI 10.5281/zenodo.3952728 :target: https://doi.org/10.5281/zenodo.3952728 -.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg - :alt: BSD-3 Clause License - :target: https://opensource.org/licenses/BSD-3-Clause +.. image:: https://img.shields.io/badge/docs-online-success + :alt: Documentation + :target: https://uproot.readthedocs.io/ + +.. image:: https://img.shields.io/badge/chat-online-success + :alt: Gitter + :target: https://gitter.im/Scikit-HEP/uproot -.. image:: https://img.shields.io/github/v/release/scikit-hep/uproot4?color=blue&label=Uproot - :alt: Latest version - :target: https://github.com/scikit-hep/uproot4/releases/latest +:raw-html:`

` |br| Uproot is a library for reading (and soon, writing) ROOT files in pure Python and NumPy.