From f793887a77c26dad0a5b480b527c52838acb8239 Mon Sep 17 00:00:00 2001 From: Hichem Fantar Date: Sun, 16 Jun 2024 21:57:23 +0100 Subject: [PATCH] feat: Update installation and local development instructions --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0c6c2c2..a04b699 100644 --- a/README.md +++ b/README.md @@ -2,40 +2,40 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. -### Installation +## Installation ``` -$ yarn +npm i ``` -### Local Development +## Local Development ``` -$ yarn start +npm 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. -### Build +## 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 +## Deployment Using SSH: ``` -$ USE_SSH=true yarn deploy +USE_SSH=true npm run deploy ``` Not using SSH: ``` -$ GIT_USER= yarn deploy +GIT_USER= 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.