Update README to remove default notes

noteable-io · Jul 17, 2023 · fd5e14a · fd5e14a
1 parent b9da3da
commit fd5e14a
Showing 1 changed file with 4 additions and 33 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -2,40 +2,11 @@
 
 This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
 
-### Installation
+### Quick Start
 
 ```
-$ yarn
+npm install
+npm run start
 ```
 
-### Local Development
-
-```
-$ yarn 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
-
-```
-$ 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
-```
-
-Not using SSH:
-
-```
-$ GIT_USER=<Your GitHub username> 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.
+**Note:** You must be in the `/docs` directory, not the root of the project