From a82d60e452b83d069a65024ac664215965cbc266 Mon Sep 17 00:00:00 2001 From: mat Date: Fri, 4 Mar 2022 20:29:19 -0600 Subject: Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f0035e0..beb1d8c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Backend for [skyblock.matdoes.dev](https://github.com/skyblockstats/skyblock-stats). -This is kinda like [Slothpixel](https://github.com/slothpixel/core), as in it fetches the SkyBlock API and cleans up the result for use without an API key. +This is kinda like [Slothpixel](https://github.com/slothpixel/core), it fetches the SkyBlock API and cleans up the result for use without an API key. ## Basically what it does @@ -19,4 +19,10 @@ This is kinda like [Slothpixel](https://github.com/slothpixel/core), as in it fe If you (this is really just here for myself so I don't forget) are adding a new API thing, follow these rules so the API is consistent with how it responds: - Use camelCase. Some old things use snake_case but these are going to be changed at some point. - Prefer arrays over dictionaries when the keys aren't static. For example `[ { name: "asdf", value: "dsfasg" } ]` rather than `{ "asdf": "dsfasg" }`. -- Idk I'll add more to here later +- "name" fields should be snake_case ids. + +## Breaking changes todo +- Replace all snake_case keys with camelCase +- Rename visited_zones to just zones since it contains every zone +- Rename collection `xp` to `amount` +- Move `/leaderboard/` to `/leaderboards/` -- cgit