From e62cd0eb894f4dcff6ca6bd76b940415fbc4545e Mon Sep 17 00:00:00 2001
From: David Cook <david@redcliffs.net>
Date: Fri, 29 Dec 2023 13:58:48 +1100
Subject: [PATCH] Add reports readme [doc]

It doesn't say much yet, but could be a helpful starting point. Hopefully we will add to it next time we're working on it.

[skip ci]
---
 lib/reporting/readme.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 lib/reporting/readme.md

diff --git a/lib/reporting/readme.md b/lib/reporting/readme.md
new file mode 100644
index 0000000000..c7f823b1f5
--- /dev/null
+++ b/lib/reporting/readme.md
@@ -0,0 +1,9 @@
+# Reports framework
+
+A framework that handles querying and rendering tabular data.
+
+TODO: add more details on how each part works.
+
+## Rules
+Rules are used for grouping, ordering, and summary rows. Options are documented at [`Reporting::ReportTemplate#rules`](
+https://github.com/openfoodfoundation/openfoodnetwork/blob/master/lib/reporting/report_template.rb#L68-L95).