add github codespace instructions

uug-ai · Jun 1, 2024 · a18e6d6 · a18e6d6
1 parent 159d5e4
commit a18e6d6
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -80,6 +80,10 @@ while True:
 
 # Dev Container
 
-Within this project we have added a `devcontainer.json` file allowing you to spin up a GitHub Codespace environment to seamless run this project.
+Within this project we have added a `devcontainer.json` file allowing you to spin up a GitHub Codespaces environment to seamless run this project.
 
+![Create GitHub Codespace](./assets/images/activate-codespace.png)
 
+Once opened you'll have a Visual Studio Code environment deployed, and you can simply navigate to the `Debug` section to run the project. Please do not forget to add your own `.env` credentials so it properly connects to your Kerberos Vault and message broker.
+
+![Open GitHub Codespace](./assets/images/run-codespace.png)
diff --git a/assets/images/activate-codespace.png b/assets/images/activate-codespace.png
diff --git a/assets/images/run-codespace.png b/assets/images/run-codespace.png