diff --git a/README.md b/README.md index b8cb060..5930219 100644 --- a/README.md +++ b/README.md @@ -1 +1,20 @@ -# obolus 💰 \ No newline at end of file +# 💰obolus + +## 🛠development + +```bash +// Clone +git clone https://github.com/CupCakeArmy/obolus.git +cd obolus + +// Local +npm run dev:local + +// With docker +npm run dev:docker +``` + +### 🗒notes + +- All code is hot-reloaded. +- When switching from `local` to `docker` please run `npm run clean` as the `sqlite3` package needs to download the right binaries for the current maschine.