From 731e1d75671ebc764dbfa052c72b0df3fbd1141a Mon Sep 17 00:00:00 2001 From: Gerald Pinder Date: Sun, 15 Oct 2023 23:23:47 -0400 Subject: [PATCH] fix: Create README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1451e95 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Ublue CLI + +This is my personal project trying to create a more conise version of the [starting point](https://github.com/ublue-os/startingpoint/tree/template) repo all condensed into a single Rust based CLI tool. + +## Installation + +Right now the only way to install this tool is to use `cargo`. + +```bash +cargo install --locked ublue-rs +``` + +## How to use + +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 recipe.yml -o Containerfile +``` + +You can then use this with `podman` to build and publish your image. Further options can be viewed by running `ublue --help` + +## Future Features + +- [ ] Update to the most recent stable style of the [starting point](https://github.com/ublue-os/startingpoint/tree/template) template +- [ ] Create an init command to create a repo for you to start out +- [ ] Setup the project to allow installing with `binstall` +- [ ] Create an install script for easy install for users without `cargo`