docs: Adds screenshot to README (#240)

canonical · Dec 7, 2023 · ab9949a · ab9949a
1 parent 17d377f
commit ab9949a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 A Network Management System for managing the SD-Core 5G core network.
 
+![Screenshot](images/nms_screenshot.png)
+
 ## Usage
 
 NMS needs to be configured with the following environment variables:
@@ -15,5 +17,5 @@ export UPF_CONFIG_PATH=/path/to/upf_config.json
 export GNB_CONFIG_PATH=/path/to/gnb_config.json
 
 docker pull ghcr.io/canonical/sdcore-nms:0.2.0
-docker run -it --env UPF_CONFIG_PATH --env GNB_CONFIG_PATH ghcr.io/canonical/sdcore-nms:0.2.0
+docker run -it --env UPF_CONFIG_PATH --env GNB_CONFIG_PATH --env WEBUI_ENDPOINT ghcr.io/canonical/sdcore-nms:0.2.0
 ```
diff --git a/images/nms_screenshot.png b/images/nms_screenshot.png