From 77348138a53de2c9517a6d8fa99e7e50527ca672 Mon Sep 17 00:00:00 2001
From: Evan Simkowitz <esimkowitz@users.noreply.github.com>
Date: Thu, 19 Sep 2024 13:03:45 -0700
Subject: [PATCH] update readme

---
 README.md | 39 +++++++++++++++++++--------------------
 1 file changed, 19 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 0c6c2c2..67f48e2 100644
--- a/README.md
+++ b/README.md
@@ -1,41 +1,40 @@
-# Website
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="./static/img/logo/wave-dark.png">
+    <source media="(prefers-color-scheme: light)" srcset="./static/img/logo/wave-light.png">
+    <img alt="Wave Terminal Logo" src="./static/img/logo/wave-light.png" width="240">
+  </picture>
+  <br/>
+</p>
+
+# Wave Terminal Documentation
+
+This is the home for Wave Terminal's documentation site.
 
 This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
 ### Installation
 
-```
-$ yarn
+```sh
+yarn
 ```
 
 ### Local Development
 
-```
-$ yarn start
+```sh
+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
+```sh
+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.
+Deployments are handled automatically by the [Deploy action](.github/workflows/deploy.yml)