From b81536a38db354c4b429114b808147b221757065 Mon Sep 17 00:00:00 2001
From: Thomas Kluyver <thomas@kluyver.me.uk>
Date: Tue, 22 Nov 2022 10:08:02 +0000
Subject: [PATCH] Add README

---
 README.rst     | 12 ++++++++++++
 pyproject.toml |  1 +
 2 files changed, 13 insertions(+)
 create mode 100644 README.rst

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..954d3c3
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,12 @@
+CalCat proxy server to help make detector corrections reproducible
+
+Detector corrections have to query `CalCat <https://in.xfel.eu/calibration/>`_
+to find calibration constants. This might be an issue for reproducibility, if
+CalCat's APIs change, or if it selects different constants to correct the same
+data. CalParrot stores CalCat responses in an SQLite database for each
+correction, and replays them if the same queries are made again, so reproducing
+a correction doesn't need to talk to CalCat again.
+
+This only affects code that works by querying the CalCat REST API, using the
+settings from ``cal_tools.restful_config``. Code that queries over ZeroMQ, using
+iCalibrationDB and calDBRemote, will bypass CalParrot.
diff --git a/pyproject.toml b/pyproject.toml
index 40d21bb..71302b4 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -5,6 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 name = "calparrot"
 authors = [{name = "EuXFEL Calibration Team"}]
+readme = "README.rst"
 dynamic = ["version", "description"]
 dependencies = [
     "oauthlib",
-- 
GitLab