diff --git a/README.md b/README.md index 01b4bf2..8a4b3e9 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,20 @@ This is the documention and blog website of the Minecraft server Survival-Pi. If you're a member of the community and want to add a blog post or information to the docs, let any admin of the server know. The docs explain how to create and submit a blog post in detail. ### Installation - +You need Node and npm for building this project. I recomment installing and managing it with nvm (https://github.com/nvm-sh/nvm): ``` -$ yarn +$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash +nvm install node +``` +Initialize the project and install dependencies: +``` +npm install ``` ### Local Development ``` -$ yarn start +$ npm 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. @@ -19,23 +24,9 @@ This command starts a local development server and opens up a browser window. Mo ### Build ``` -$ yarn build +$ npm run 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 contents hosting service or with `npm run serve`. -### Deployment -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -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.