From 8e39dbddfaed4b71869287ad597089d981c2a983 Mon Sep 17 00:00:00 2001
From: Ben Zhang <ben.zhang@watonomous.ca>
Date: Mon, 15 Jul 2024 22:14:30 +0000
Subject: [PATCH] Update README

---
 README.md | 36 ++++++++++--------------------------
 1 file changed, 10 insertions(+), 26 deletions(-)

diff --git a/README.md b/README.md
index 0d6babe..ac91370 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,14 @@
-# React + TypeScript + Vite
+# WATcloud Status Page
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+The [WATcloud Status Page](https://status.watonomous.ca) is a frontend-only web app that pulls data from various sources like [Healthchecks.io](https://healthchecks.io)
+and [Sentry](https://sentry.io) to provide a single place to view the health of WATcloud.
 
-Currently, two official plugins are available:
+## Development
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+To run the status page locally, you will need to have [Node.js](https://nodejs.org/en/) installed.
+Then, you can run the following commands to install dependencies and start the development server:
 
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
-
-- Configure the top-level `parserOptions` property like this:
-
-```js
-export default {
-  // other rules...
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-  },
-}
-```
-
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+```bash
+npm install
+npm run dev
+```
\ No newline at end of file