From 7d8feb658057e09fc8d0fe113dcf28fcc005c1d3 Mon Sep 17 00:00:00 2001
From: Maria McParland <78078583+maria-mcparland@users.noreply.github.com>
Date: Tue, 9 Jan 2024 12:25:32 +0000
Subject: [PATCH] Create README.md

---
 metrics/README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 metrics/README.md

diff --git a/metrics/README.md b/metrics/README.md
new file mode 100644
index 0000000..66002fc
--- /dev/null
+++ b/metrics/README.md
@@ -0,0 +1,10 @@
+# Metrics Gathering
+
+We've created a bash script that runs daily to collect our metrics and store them as csv.
+This is because _currently_ GitHub is only storing the last 14days worth of data.
+
+We use the [github_traffic_stats](https://github.com/nchah/github-traffic-stats) python package to gather our metrics in three csv files.
+
+Then we have created merge.sh to merge these metrics with the previous days csv and then sort by date order.
+
+We are storing our latest metrics files on a branch called 'metrics'. This is because we don't want to push directly to main.