Skip to content

Commit 76cdb26

Browse files
committed
update readme
1 parent 79155c6 commit 76cdb26

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- AUTOMATION BADGES -->
22

33
[![CodeQL](https://github.com/webceyhan/webceyhan.github.io/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/webceyhan/webceyhan.github.io/actions/workflows/github-code-scanning/codeql)
4-
[![Build and Deploy](https://github.com/webceyhan/webceyhan.github.io/actions/workflows/build-deploy.yml/badge.svg)](https://github.com/webceyhan/webceyhan.github.io/actions/workflows/build-deploy.yml)
4+
[![Build and Deploy](https://github.com/webceyhan/webceyhan.github.io/actions/workflows/deploy.yml/badge.svg)](https://github.com/webceyhan/webceyhan.github.io/actions/workflows/deploy.yml)
55

66
<!-- LOGO (OPTIONAL) -->
77

@@ -26,7 +26,7 @@ Feel free to use it as your own landing page if you like.
2626

2727
## Requirements
2828

29-
You need to install the [Node.js](https://nodejs.dev/) and `npm` package manager first.
29+
You need to install the [Bun](https://bun.sh/) first.
3030

3131
> Recommended IDE:
3232
> [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar)
@@ -44,9 +44,9 @@ You need to install the [Node.js](https://nodejs.dev/) and `npm` package manager
4444
```sh
4545
cd webceyhan.github.io
4646
```
47-
3. Install NPM packages.
47+
3. Install packages.
4848
```sh
49-
npm install
49+
bun install
5050
```
5151
4. Set your social link handles in .env file.
5252
```sh
@@ -74,9 +74,9 @@ You need to install the [Node.js](https://nodejs.dev/) and `npm` package manager
7474
You can use following commands to do various task with the project.
7575

7676
```sh
77-
npm run dev # start development server
78-
npm run build # build for production
79-
npm run preview # preview built application
77+
bun run dev # start development server
78+
bun run build # build for production
79+
bun run preview # preview built application
8080
```
8181

8282
> Take a look at the other scripts in [`package.json`](./package.json)
@@ -90,7 +90,7 @@ npm run preview # preview built application
9090
Start the development server to watch changes while you code.
9191

9292
```sh
93-
npm run dev
93+
bun run dev
9494
```
9595

9696
<br>
@@ -101,13 +101,13 @@ npm run dev
101101
Build the application for production.
102102

103103
```sh
104-
npm run build
104+
bun run build
105105
```
106106

107107
You can also preview the application after building it.
108108

109109
```sh
110-
npm run preview
110+
bun run preview
111111
```
112112

113113
<br>
@@ -117,9 +117,9 @@ npm run preview
117117

118118
A GitHub Action will automatically deploy the project to GitHub Pages on every push.
119119

120-
The workflow will build the project using npm and output the result to the `dist` folder which will be then pushed to the `gh-pages` branch.
120+
The workflow will build the project using bun and output the result to the `dist` folder which will be then pushed to the `gh-pages` branch.
121121

122-
> See the details in [.github/workflows/build-and-deploy.yml](./.github/workflows/build-and-deploy.yml)
122+
> See the details in [.github/workflows/deploy.yml](./.github/workflows/deploy.yml)
123123

124124
<br>
125125
<!-- REFERENCES ////////////////////////////////////////////////////////// -->

0 commit comments

Comments
 (0)