Update README.md

mkelly · Oct 19, 2023 · bc0c346 · bc0c346
1 parent dc11156
commit bc0c346
Showing 1 changed file with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,17 @@
-# bindplane-gitflow-cli
+# Sample GitHub Workflows for BindPlane OP
+
+A collection of examples using the BindPlane API to enable GitOps workflows.
+
+## Basic Workflow
+
+Using a single BindPlane resource definition YAML to synchronize changes.
+
+When a file is changed, a GitHub action is triggered to reapply the resource definitions to BindPlane.
+
+## Standard Workflow
+
+A sample workflow that automatically synchronizes a directory of BindPlane components with a BindPlane instance.
+
+## Raw OTel Workflow
+
+A sample workflow that uses raw OpenTelemetry collector configurations and synchronizes changes with a BindPlane instance