particle-os/particle-os-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Update README and CHANGELOG

Browse source
This commit is contained in:
Gerald Pinder 2023-12-27 21:06:26 -05:00
parent a25e0418c4
commit c559fb4d6b
2 changed files with 14 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -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