README.md: add general description

This commit is contained in:
Christian Kellner 2020-09-09 16:12:26 +02:00
parent 3f5de8a68d
commit 857ae4ad77

View file

@ -1,3 +1,15 @@
# Koji osbuild
This project provides osbuild integration with Koji. This is done via three
plugins:
- Koji **hub** plugin: Provides a new XMLRPC API endpoint that clients
can use to create new `osbuildImage` Koji tasks.
- Koji **builder** plugin: Handles `osbuildImage` Koji tasks and will talk
to osbuild-composer to create new composes via composer's Koji API.
- Koji **cli** plugin: Adds a new `osbuild-command` to the existing `koji`
command line client. This will then use the new XMLRPC API to request a
new compose.
## Building the containers