diff --git a/README.md b/README.md index 2d19395..344a886 100644 --- 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) \ No newline at end of file diff --git a/assets/images/activate-codespace.png b/assets/images/activate-codespace.png new file mode 100644 index 0000000..4029e3e Binary files /dev/null and b/assets/images/activate-codespace.png differ diff --git a/assets/images/run-codespace.png b/assets/images/run-codespace.png new file mode 100644 index 0000000..1a11470 Binary files /dev/null and b/assets/images/run-codespace.png differ