From f45cc2cd1c0ef84a4e992dbe013265b35414e080 Mon Sep 17 00:00:00 2001
From: Zynh0722 <Zynh0722@gmail.com>
Date: Thu, 8 Feb 2024 19:46:41 -0800
Subject: [PATCH] add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4c960fd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# lol-pairing-stat-fetcher
+
+### setup
+
+```sh
+npm ci
+```
+
+### running code
+
+#### with docker-compose
+
+```sh
+docker-compose up
+```
+
+#### on its own
+
+Note: you will need to provide your own redis, or disable redis caching by switching from `"ioredis"` to `"local"`
+
+```sh
+npm start
+```
+
+##### with cache debugging
+
+```sh
+npm run debug-cache
+```