aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-04-06 20:11:26 -0700
committerFuwn <[email protected]>2021-04-06 20:11:26 -0700
commit6e04b1bab644045398b213900b60bf1ac1c0272d (patch)
tree0cc17281bbd67244efc3c23e71297c9cbaa9c0d8 /README.md
parentchore: Create contribution guidelines (diff)
downloadsite-6e04b1bab644045398b213900b60bf1ac1c0272d.tar.xz
site-6e04b1bab644045398b213900b60bf1ac1c0272d.zip
major: Furnish repository
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 33 insertions, 2 deletions
diff --git a/README.md b/README.md
index d3c9ed2..8960fa2 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,33 @@
-# site
-The official Whirlsplash guide and blog.
+# Website
+
+This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
+
+## 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.
+
+## Build
+
+```console
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+```console
+GIT_USER=<Your GitHub username> 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.