From ba3b61969a12af41a22bc6ecd39e92362665d733 Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Tue, 19 Jan 2021 18:15:16 -0500 Subject: [PATCH] docs: Add something to the README --- README.md | 2 ++ docs/index.rst | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e6117ca..7ba2fe5 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ [![Scikit-HEP][sk-badge]](https://scikit-hep.org/) +This is a package meant primarily for documenting histogram indexing and the PlottableProtocol and any future cross-library standards. It also contains the code for the PlottableProtocol, to be used in type checking libraries wanting to conform to the protocol. Eventually, it might gain a set of tools for testing conformance to UHI indexing, as well. It is not intended to be a runtime dependency, but only a type checking, testing, and/or docs dependency in support of our other libraries (boost-histogram, hist, mplhep, histoprint). It requires Python 3.6+. + [actions-badge]: https://github.com/Scikit-HEP/uhi/workflows/CI/badge.svg [actions-link]: https://github.com/Scikit-HEP/uhi/actions diff --git a/docs/index.rst b/docs/index.rst index 7b49e2d..ccdc866 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,7 @@ UHI: Unified Histogram Interface This is the home for the Unified Histogram Interface documentation. -This currently holds the Indexing specification, and the PlottibleProtocol +This currently holds the Indexing specification, and the PlottableProtocol definition.