From bc0c3464d47e61c76da21c99a0b42842f6a7ebb4 Mon Sep 17 00:00:00 2001 From: Michael Kelly Date: Thu, 19 Oct 2023 11:40:00 -0400 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5951b9c..605113b 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -# bindplane-gitflow-cli \ No newline at end of file +# 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