Update Readme:

Add note on running in and out of Docker. Signed-off-by: Jacob Weinstock <[email protected]>
tinkerbell · Mar 7, 2024 · 5f233f1 · 5f233f1
1 parent 6e99a40
commit 5f233f1
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/playground/Dockerfile b/playground/Dockerfile
@@ -1,5 +1,5 @@
-# docker build -t deps .
-# docker run -it --rm --network host -v /tmp:/tmp -v /var/run/docker.sock:/var/run/docker.sock -v /var/run/libvirt/libvirt-sock-ro:/var/run/libvirt/libvirt-sock-ro -v /var/run/libvirt/libvirt-sock:/var/run/libvirt/libvirt-sock --name capt-playground deps
+# docker build -t capt-playground .
+# docker run -it --rm --network host -v /tmp:/tmp -v /var/run/docker.sock:/var/run/docker.sock -v /var/run/libvirt/libvirt-sock-ro:/var/run/libvirt/libvirt-sock-ro -v /var/run/libvirt/libvirt-sock:/var/run/libvirt/libvirt-sock --name capt-playground capt-playground
 FROM alpine
 
 ADD https://github.com/kubernetes-sigs/cluster-api/releases/download/v1.6.1/clusterctl-linux-amd64 /usr/local/bin/clusterctl 

diff --git a/playground/README.md b/playground/README.md
@@ -1,5 +1,23 @@
 # CAPT Playground
 
+## Usage
+
+The CAPT playground can be run as a standalone binary or via Docker.
+
+### Standalone
+
+```bash
+capt-playground -h
+```
+
+### Docker
+
+```bash
+docker build -t capt-playground .
+docker run -it --rm --network host -v /tmp:/tmp -v /var/run/docker.sock:/var/run/docker.sock -v /var/run/libvirt/libvirt-sock-ro:/var/run/libvirt/libvirt-sock-ro -v /var/run/libvirt/libvirt-sock:/var/run/libvirt/libvirt-sock --name capt-playground capt-playground
+capt-playground -h
+```
+
 ## Known Issues
 
 ### DNS issue