From 7ebaefe1dc69336bb49825eaa370c78560a99024 Mon Sep 17 00:00:00 2001
From: Tamas Gal <tgal@km3net.de>
Date: Fri, 17 Jul 2020 13:39:36 +0200
Subject: [PATCH] Update readme

---
 README.rst | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.rst b/README.rst
index 20a28aa..e63c05e 100644
--- a/README.rst
+++ b/README.rst
@@ -10,3 +10,25 @@ KM3NeT TestData
 .. image:: https://examples.pages.km3net.de/km3badges/docs-latest-brightgreen.svg
     :target: https://km3py.pages.km3net.de/km3net_testdata
 
+
+A package to get access to KM3NeT sample files for testing and development
+purposes.
+
+Installation and usage
+----------------------
+
+    pip install km3net_testdata
+
+The file paths can be access in Python scripts using the ``data_path()`` function:
+
+.. code-block:: python
+
+    from km3net_testdata import data_path()
+
+    filename = data_path("km3net_offline.root")
+
+
+Acknowledgements
+----------------
+
+The project idea and implementation were inspired by the Scikit-HEP Project https://github.com/scikit-hep/scikit-hep-testdata
-- 
GitLab