diff --git a/README.md b/README.md index 1cc06f6..4ceea1c 100644 --- a/README.md +++ b/README.md @@ -6,30 +6,22 @@ This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern ## Installation -```console yarn install -``` ## Local Development -```console yarn start -``` -This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. +This command starts a local development server and opens up a browser window. Most changes are reflected live without needing to restart the server. ## Build -```console yarn build -``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. +This command generates static content into the `build` directory and can be served using any static content hosting service. ## Deployment -```console GIT_USER= USE_SSH=true 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. +If you are using GitHub Pages for hosting, this command is a convenient way to build the website and push it to the `gh-pages` branch.