diff --git a/README.md b/README.md index 38a2467..17431e9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ # web LibreCloud's website + +## Dev Server Instructions + +1. **Install Bun if you haven't already** + + Bun is a fast JavaScript runtime, and is much faster than `npm`. These instructions will be written for Bun, but could be adapted to `npm` or `yarn` if needed. + +2. **Clone the repo** + + ```bash + git clone https://git.pontusmail.org/LibreCloud/web.git + cd web + ``` + +3. **Install dependencies** + + ```bash + bun install + ``` + +4. **Start dev server** + + ```bash + bun dev + ```