Update readme

pawurb · Nov 22, 2024 · 83c8695 · 83c8695
1 parent 24ba18f
commit 83c8695
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -122,6 +122,24 @@ pgextras diagnose
 
 ![Diagnose report](pg-extras-diagnose-report.png)
 
+## Web UI
+
+Alternatively, you can use the application via the web UI. You have to enable the `web` feature flag:
+
+```bash
+cargo install pg-extras --features="web"
+```
+
+Now you can run:
+
+```
+pgextras web
+```
+
+To run the server on `http://localhost:3000` (you can customize the port by setting the `PORT` ENV).
+
+![Web UI](pg-extras-web-ui.png)
+
 Keep reading to learn about methods that `diagnose` uses under the hood.
 
 ## Available methods

diff --git a/pg-extras-web-ui.png b/pg-extras-web-ui.png