docs: Update README and CHANGELOG
This commit is contained in:
parent
a25e0418c4
commit
c559fb4d6b
2 changed files with 14 additions and 2 deletions
|
|
@ -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)
|
||||
|
||||
<csr-id-603a3335f9cd97a1905dae6c909f95bcff051686/>
|
||||
<csr-id-ea6143c7f7e628ea2958ccf8193c4e0e68595d2c/>
|
||||
|
|
|
|||
14
README.md
14
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 <CONTAINERFILE> <RECIPE_FILE>
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue