diff --git a/CHANGELOG.md b/CHANGELOG.md index 78de502..adf7ffb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## Unreleased +## v0.3.4 (2023-12-18) diff --git a/README.md b/README.md index 0b9e7e0..98e83ef 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,25 @@ cargo install --locked ublue-rs ## How to use +### Templating + Once you have the CLI tool installed, you can run the following to pull in your recipe file to generate a `Containerfile`. ```bash ublue template -o ``` -You can then use this with `podman` to build and publish your image. Further options can be viewed by running `ublue --help` +You can then use this with `podman` to build and publish your image. Further options can be viewed by running `ublue template --help` + +### Building + +If you don't care about the details of the template, you can run the `build` command. + +```bash +ublue build ./config/recipe.yaml +``` + +This will template out the file and build with `buildah` or `podman`. If you're running in Gitlab CI with the pipeline like in the [init template](templates/init/gitlab-ci.yml.tera), it will automatically sign your image using Gitlab's own OIDC service. ## Future Features