From 99122495cf1e4a32444e2017f9a506363a7f185e Mon Sep 17 00:00:00 2001 From: linda Date: Fri, 13 Sep 2024 10:28:58 -0700 Subject: [PATCH] fix docs readme file --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4ca330e4a..24841f6de 100644 --- a/README.md +++ b/README.md @@ -5,25 +5,31 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta ### Installation ``` -$ npm +$ npm install ``` - -### Local Development +Make sure that you've cloned the `defanglabs/defang` repo and `defanglabs/samples` repo in sibling directories. ``` -$ npm serve +$ git clone https://github.com/DefangLabs/defang.git ../defang +$ git clone https://github.com/DefangLabs/samples.git ../samples ``` -This command starts a local development server and opens up a browser window. - ### Build ``` -$ npm build +$ npm run build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. +### Local Development + +``` +$ npm run start +``` + +This command starts a local development server and opens up a browser window. + ### Deployment Using SSH: