Skip to content

Commit 15e676e

Browse files
authored
chore: update readme build docs (see #477)
1 parent ba6d5b4 commit 15e676e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The interesting thing about Musicale is that there is no backend and the API it'
4848

4949
## Development
5050

51-
To get started, make sure to have Git and Node.js (>= 16.0.0) installed.
51+
To get started, make sure to have `git` and [`bun`](https://bun.sh/) installed.
5252

5353
Clone the repo and `cd` it:
5454

@@ -58,19 +58,19 @@ git clone https://github.com/Bellisario/musicale.git && cd musicale
5858

5959
Install dependencies:
6060
```bash
61-
npm install
61+
bun install
6262
```
6363

6464
Then, you can run the following command to start the server (in DEV mode):
6565

6666
```bash
67-
npm run dev
67+
bun run dev
6868
```
6969

7070
After done, to build the project run:
7171

7272
```bash
73-
npm run build
73+
bun run build
7474
```
7575

7676
> **Info:** we're using [Deno Deploy](https://deno.com/deploy) as server hosting so all the build files will go inside `dist/public` and not `dist`.\
@@ -79,10 +79,10 @@ npm run build
7979
If you want to preview the build run:
8080

8181
```bash
82-
npm run preview
82+
bun run preview
8383
```
8484

85-
Before opening a pull, please make sure to run `npm run check` to check for warnings, errors, etc. and format your code with VSCode (Svelte extension).
85+
Before opening a pull, please make sure to run `bun run check` to check for warnings, errors, etc. and format your code with VSCode (Svelte extension).
8686

8787
## Contributing
8888

0 commit comments

Comments
 (0)