From bcc7b8c0a3678a1abab6b44284e6b3d190f790e9 Mon Sep 17 00:00:00 2001
From: CrispyPin <crispin@tasa.se>
Date: Thu, 25 Jan 2024 12:16:42 +0100
Subject: [PATCH] add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ee8af0b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# compiler timer
+Add before your compiler and arguments to store a history of compilation times and print statistics.
+
+Example output:
+```
+<regular compiler output>
+
+Build took 18.025s
+Total wasted today: 44m 5s
+5 day average: 35m 38s
+Overall average: 40m 22s
+Since 2023-09-07: 55h 11m 22s
+```
+
+Run with no arguments to just print the overall stats.
+