From 168928f0e7812d37aec5dcd7830648220d9ad8f3 Mon Sep 17 00:00:00 2001
From: MrCroxx <mrcroxx@outlook.com>
Date: Sun, 15 Sep 2024 23:26:57 +0800
Subject: [PATCH] chore: update readme

Signed-off-by: MrCroxx <mrcroxx@outlook.com>
---
 README.md | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 0c6c2c2..a2e0bf1 100644
--- a/README.md
+++ b/README.md
@@ -5,13 +5,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
 ### Installation
 
 ```
-$ yarn
+$ npm
 ```
 
 ### Local Development
 
 ```
-$ yarn start
+$ npm run start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
@@ -19,23 +19,29 @@ This command starts a local development server and opens up a browser window. Mo
 ### Build
 
 ```
-$ yarn build
+$ npm run build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
 ### Deployment
 
+#### Automatically
+
+Updates will be automatically push to github pages via github action after merging into main. Sit back and relax.
+
+#### Manually (not recommended)
+
 Using SSH:
 
 ```
-$ USE_SSH=true yarn deploy
+$ USE_SSH=true npm run deploy
 ```
 
 Not using SSH:
 
 ```
-$ GIT_USER=<Your GitHub username> yarn deploy
+$ GIT_USER=<Your GitHub username> npm run deploy
 ```
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.