From 89a4f61f007ec03ddf37f2a27ea47f82a860d7b5 Mon Sep 17 00:00:00 2001
From: AnOpenSauceDev <119765865+AnOpenSauceDev@users.noreply.github.com>
Date: Thu, 4 Jan 2024 15:30:22 +1000
Subject: [PATCH] 0.2.0 readme updates

---
 README.md | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index b05220b..a601bea 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,21 @@
 
 A pretty tiny mod that checks the hashes of every mod in your mods folder against Modrinth to see if the mod you're using is tamper-free.
 
-Works as long **as you have less than 300 _individual (.jar file)_ mods** (because you'll get rate-limited going past that.)
+Works as long **as you have less than 300 _individual (.jar file)_ mods** (because you'll get rate-limited going past that, also assuming this is the first run.)
 
 Due to this mod using the Modrinth API, this will fail checks on binaries from CurseForge/Github that aren't identical to what's on Modrinth.
 
 This mod is very much in its infancy, with quite a bit of work still to go.
 
-**TODO:**
-- Cache results in a **secure** way to not send nearly as many API calls.
-- ~~multithread everything~~ Done!
+## Caching System
+
+As of 0.2.0, the ITML will resolve to one of two hash "databases"
+- `~/.minecraft/config/ITML.cache`
+- Modrinth's "version from hash" API.
+  
+After verifying a hash with the Modrinth API, the mod's hash will be stored over in `ITML.cache`, of which any hashes located in there will be whitelisted (with a notice in the logger itself.)
+This essentially means that there should only be a noticable increase in load times when opening a **large** modpack for the first time.
+
+This also means that you only need to connect to the internet once at startup to verify your mods, and to recconnect when you add/update any mods.
+
+To rebuild the cache, just delete the file, nothing will break.