aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormat <github@matdoes.dev>2022-02-16 23:15:26 -0600
committermat <github@matdoes.dev>2022-02-16 23:15:26 -0600
commit803e1321e70e0538f63cc3c933823a8897d84965 (patch)
treef24736615d29bd2e98473eb24e2cc30154bf8f71 /README.md
parentff6dcfbe52cc325fce1acd3cb4f160d233967eec (diff)
downloadskyblock-api-803e1321e70e0538f63cc3c933823a8897d84965.tar.gz
skyblock-api-803e1321e70e0538f63cc3c933823a8897d84965.tar.bz2
skyblock-api-803e1321e70e0538f63cc3c933823a8897d84965.zip
move maxUniqueMinions
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6390ac5..f0035e0 100644
--- a/README.md
+++ b/README.md
@@ -13,3 +13,10 @@ This is kinda like [Slothpixel](https://github.com/slothpixel/core), as in it fe
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
+
+## API conventions
+
+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