diff options
| author | mat <github@matdoes.dev> | 2022-03-04 20:29:19 -0600 |
|---|---|---|
| committer | mat <github@matdoes.dev> | 2022-03-04 20:29:19 -0600 |
| commit | a82d60e452b83d069a65024ac664215965cbc266 (patch) | |
| tree | 3139413518b85fe498ec96f6f7cd0d757e9d1411 | |
| parent | 9df66a014a945900f553165db3d4a863a864aece (diff) | |
| download | skyblock-api-a82d60e452b83d069a65024ac664215965cbc266.tar.gz skyblock-api-a82d60e452b83d069a65024ac664215965cbc266.tar.bz2 skyblock-api-a82d60e452b83d069a65024ac664215965cbc266.zip | |
Update README.md
| -rw-r--r-- | README.md | 10 |
1 files changed, 8 insertions, 2 deletions
@@ -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/` |