diff --git a/README.md b/README.md index 55d0c3e..ccbcf87 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,31 @@ -# Website +# The open-source repo for [docs.halo.run](https://docs.halo.run) This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. ### Installation ``` -$ yarn +$ pnpm install ``` -### Local Development +> If you don’t have pnpm installed, you can install it with the following command: ``` -$ yarn start +npm install -g pnpm ``` -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 +### Local Development ``` -$ yarn build +$ pnpm start ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. -### Deployment +### Build ``` -$ GIT_USER= USE_SSH=true yarn deploy +$ pnpm build ``` -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. +This command generates static content into the `build` directory and can be served using any static contents hosting service.