From 6462f4a06b99adb85d8f502e654578a4d216d609 Mon Sep 17 00:00:00 2001
From: Sam Wright <sam@sams-mbp.lan>
Date: Wed, 19 Jun 2024 23:11:43 +1000
Subject: [PATCH] Update /web readme

---
 web/.vscode/extensions.json |  5 +++++
 web/README.md               | 21 ++++++++++++++++-----
 2 files changed, 21 insertions(+), 5 deletions(-)
 create mode 100644 web/.vscode/extensions.json

diff --git a/web/.vscode/extensions.json b/web/.vscode/extensions.json
new file mode 100644
index 000000000..7dea559d5
--- /dev/null
+++ b/web/.vscode/extensions.json
@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+      "dbaeumer.vscode-eslint"
+    ]
+  }
\ No newline at end of file
diff --git a/web/README.md b/web/README.md
index 6c994f77d..a2d84fbad 100644
--- a/web/README.md
+++ b/web/README.md
@@ -1,10 +1,21 @@
-# To run
+This is the Frigate frontend which connects to and provides a User Interface to the Python backend.
+
+# Installing
+Within `/web`, run:
+
 ```bash
 npm install
+```
+
+# Running
+Within `/web`, run:
+
+```bash
 PROXY_HOST=<ip_address:port> npm run dev
 ```
 
-# Tech stack
-- React
-- TypeScript
-- Vite
+The Proxy Host can point to your existing Frigate instance. Otherwise defaults to `localhost:5000` if running Frigate on the same machine.
+
+# Extensions
+Install these IDE extensions for an improved development experience:
+- eslint