summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorFelix Pojtinger <felix@pojtinger.com>2019-04-27 03:39:06 +0200
committerFelix Pojtinger <felix@pojtinger.com>2019-04-27 03:39:06 +0200
commitbeb4981c22462f4d671fe1098320ff32e1f1c271 (patch)
treee59c5ed5c924767b897b17763ba59a8f49d22e28 /README.md
parent847e6bfb5ba92ddbdca878baebcc90a53efbf50f (diff)
build: Fix hot reloading of UI, improve docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index 33798d14..cdd8c34c 100644
--- a/README.md
+++ b/README.md
@@ -83,19 +83,21 @@ skaffold run -p lemmy--prod
#### Kubernetes
-This requires:
+##### Requirements
-- Local or remote Kubernetes Cluster, i.e. [`minikube`](https://kubernetes.io/docs/tasks/tools/install-minikube/)
+- Local or remote Kubernetes cluster, i.e. [`minikube`](https://kubernetes.io/docs/tasks/tools/install-minikube/)
- [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
- [`skaffold`](https://skaffold.dev/)
-After satisfying the requirements, run the following:
+##### Running
```bash
skaffold dev -p lemmy--dev
```
-And goto http://localhost:4444.
+And goto http://localhost:4444 (automatically proxies to localhost, both if the cluster is local or remote).
+
+It hot-reloads the UI and automatically recompiles the server.
#### Non-Kubernetes