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).