From 9459924f92cf5e6b9a9876afb508552388f8458d Mon Sep 17 00:00:00 2001 From: Owen Date: Thu, 27 Feb 2025 10:29:05 -0500 Subject: [PATCH] Update readme; basic changes --- README.md | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 422000b..99f61e3 100644 --- a/README.md +++ b/README.md @@ -5,41 +5,26 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati ### Installation ``` -$ yarn +$ npm i ``` ### Local Development ``` -$ yarn start +$ cd packages/docusaurus/ +$ npm run dev ``` 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 - -``` -$ yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - ### Deployment Using SSH: ``` -$ USE_SSH=true yarn deploy +$ npx sst deploy --stage prod ``` -Not using SSH: - -``` -$ GIT_USER= yarn 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. - # License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. \ No newline at end of file