aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5efb77d..bf28cae 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,13 @@
The thing that powers [skyblock.matdoes.dev](https://github.com/mat-1/skyblock-stats)
Basically this is [Slothpixel](https://github.com/slothpixel/core) but more specialized
+
+## What it does
+
+1) A request is sent to the Express server in index.js
+2) The express server then calls a function in hypixelCached depending on the request
+3) hypixelCached will either directly return already-cached data, or continue to hypixel.ts
+4) hypixel.ts will call hypixelApi to get the raw data from the Hypixel API
+5) hypixel.ts calls one or more of the cleaners, which pretties up the data for us to use
+6) cleaned data is returned to hypixelCached, which will cache it
+7) Data is sent back to express to serve to the user