diff options
| author | mat <27899617+mat-1@users.noreply.github.com> | 2021-02-13 14:44:39 -0600 |
|---|---|---|
| committer | mat <27899617+mat-1@users.noreply.github.com> | 2021-02-13 14:44:39 -0600 |
| commit | e9bd7f931e071311ff9a3b83673042f8da352554 (patch) | |
| tree | de76a76134c99ab7df1ef92a30bc28afc791f6a0 /README.md | |
| parent | 68c07e7a5ab8acf5ba7785eed594497e05467061 (diff) | |
| download | skyblock-api-e9bd7f931e071311ff9a3b83673042f8da352554.tar.gz skyblock-api-e9bd7f931e071311ff9a3b83673042f8da352554.tar.bz2 skyblock-api-e9bd7f931e071311ff9a3b83673042f8da352554.zip | |
add explanation in readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -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 |