From 204b9030c9703ddfbda50eeadc23dedd7b5cffc9 Mon Sep 17 00:00:00 2001
From: Andrew Maguire <andrewm4894@gmail.com>
Date: Tue, 3 Jan 2023 15:52:48 +0000
Subject: [PATCH] add readme

---
 .devcontainer/README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/.devcontainer/README.md b/.devcontainer/README.md
index 41bcbdb8..edb741b0 100644
--- a/.devcontainer/README.md
+++ b/.devcontainer/README.md
@@ -1,3 +1,19 @@
 # devcontainer
 
-todo
+## example usage
+
+Below are some example use cases you might want to run from within the devcontainer (either within VSCode or GitHub Codespaces).
+
+### Run pre-commit
+
+```bash
+# run pre-commit
+pre-commit run --all-files
+```
+
+### Docker compose
+
+```bash
+# build the image
+docker compose up --build
+```