From 3def0223d5f2d1d837724568418931ad78a32bf4 Mon Sep 17 00:00:00 2001
From: Lloyd Dakin <54085254+LTDakin@users.noreply.github.com>
Date: Mon, 23 Dec 2024 13:58:53 -0800
Subject: [PATCH] Update README.md

Details about app and both method of running the app
---
 README.md | 36 ++++++++++++++++++++++--------------
 1 file changed, 22 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 644c8d14..df93ccc0 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,32 @@
-# datalab
+# Datalab-UI
 
-## Project setup
-```
-npm install
-```
+Frontend for the Datalab project. Connected to a [Backend Django Application](https://github.com/LCOGT/ptr_datalab) as well as the Science Archive.
+### Important Technologies
+- VueJs: Web Framework
+- Vuetify: Component Library
+- Leaflet Maps: Mapping Library
+- Pinia: Global Store
+
+## Development
+
+There are two ways to run this project; running the app on your machine directly with NPM V.S the more complete local kube cluster method. 
 
-### Compiles and hot-reloads for development
+If you need fast feedback and iterative development the minimal dev will be simplier,
+but you should also test it and make sure it works using the full kubernetes cluster method before opening a PR.
+
+### 1. Local Machine
 ```
+npm install
 npm run serve
 ```
 
-### Compiles and minifies for production
+### 2. Full K8s Enviorment
+Enter the nix enviorment and ensure local cluster and registry are running
 ```
-npm run build
+  nix develop --impure
+  ctlptl apply -f local-registry.yaml -f local-cluster.yaml
 ```
-
-### Lints and fixes files
+Start the cluster and app
 ```
-npm run lint
+skaffold -m app dev --port-forward
 ```
-
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).