fix: Create README

This commit is contained in:
Gerald Pinder 2023-10-15 23:23:47 -04:00
parent 0e4036ba86
commit 731e1d7567

28
README.md Normal file
View file

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