about time i added a readme

2023-11-12 21:52:21 +03:00 · 2023-11-12 21:52:21 +03:00 · 9c955be502
parent 358984b474
commit 9c955be502
1 changed files with 31 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,31 @@
+# jillo
+
+the goop :)
+
+![](https://oat.zone/jilloref-2.png)
+
+## Setup
+
+```sh
+pnpm install knex -g
+# rerun after each update
+pnpm install
+knex migrate:latest
+```
+
+<small>(`npm` instead of `pnpm` will also suffice)</small>
+
+Copy `config.example.json` to `config.json` and change as necessary
+
+## Dev
+
+```sh
+pnpm deploy-commands -- --dev
+pnpm dev
+```
+
+## Run
+
+```sh
+pnpm start
+```