diff --git a/README.md b/README.md index 6897a55..2c64f25 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,12 @@ VERT is a file conversion utility that uses WebAssembly to convert files on your device instead of a cloud. Check out the live instance at [vert.sh](https://vert.sh). -VERT is built in Svelte and TypeScript. +This project uses Svelte & TypeScript (via [bun](https://bun.sh)). + +## Development + +- Clone the project - `git clone https://github.com/not-nullptr/VERT.git` +- Use [bun](https://bun.sh) to install the dependencies - `bun install` +- Copy `.env.example` to `.env` and make any changes (if wanted) +- Start a dev environment & make your changes - `bun run dev` +- Build and preview for production - `bun run build` & `bun run preview` \ No newline at end of file