aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormat <github@matdoes.dev>2022-04-23 14:10:08 -0500
committermat <github@matdoes.dev>2022-04-23 14:10:08 -0500
commit57cb3e84f9c8f513665e364459c8ff342d9b3d74 (patch)
tree240f7687e69f5d95543e5993036c2165678fbc85 /README.md
parent6a7249c7b46aab070d029e22bee57e1e314001f5 (diff)
downloadskyblock-api-57cb3e84f9c8f513665e364459c8ff342d9b3d74.tar.gz
skyblock-api-57cb3e84f9c8f513665e364459c8ff342d9b3d74.tar.bz2
skyblock-api-57cb3e84f9c8f513665e364459c8ff342d9b3d74.zip
add some missing things to `claimed`
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0e3216d..59937b2 100644
--- a/README.md
+++ b/README.md
@@ -22,3 +22,11 @@ If you (this is really just here for myself so I don't forget) are adding a new
- Use snake_case for values.
- Prefer arrays over dictionaries when the keys aren't static. For example `[ { name: "asdf", value: "dsfasg" } ]` rather than `{ "asdf": "dsfasg" }`.
- Dates are done with milliseconds since epoch
+- Fields that contain a snake_case ID should be called `id`. At the moment some of them are called `name`, this will be changed soon.
+
+## Development
+
+First, install the dependencies with `npm i`.
+Then to run it, do `tsc -w` in one terminal, `npx nodemon build` in another. This makes it automatically restart when you make a change.
+If you don't like it auto restarting, then just do `node build` instead of `npx nodemon build`.
+