From 5aed38a484db7d4997e0a9fe202a48fd703bb7d6 Mon Sep 17 00:00:00 2001 From: kjuulh Date: Thu, 29 Dec 2022 02:50:33 +0100 Subject: [PATCH] add readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fb24350 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Bust + +Bust is a platform agnostic pipeline. It is built on top of `dagger` and +`kjuulh/byg`. The goal of this project is to produce a way to easily extend and +interact with a golang pipeline for CI + +## Examples + +see `examples` for example pipelines, thought do note that the project usually +needs to be self-contained like the `ci` folder. `Bust` is built with `Bust` +after all. + +To run simply `go run example/golang-bin/main.go`, this may require certain +setup for docker-hub, or alternate registries.