Skip to content

Commit

Permalink
Docs: Reword README and Makefile-comment to avoid "image-builder"
Browse files Browse the repository at this point in the history
We'll avoid the name "image-builder" here, as this repository is
now renamed to `image-builder-crc` and the command line
interface tool and RPM is called `image-builder`.
See: https://github.com/osbuild/image-builder-cli
  • Loading branch information
schuellerf authored and croissanne committed Feb 12, 2025
1 parent 2eff33e commit 725c4d6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ PACKAGE_NAME = image-builder
help:
@echo "make [TARGETS...]"
@echo
@echo "This is the maintenance makefile of image-builder. The following"
@echo "This is the maintenance makefile of image-builder-crc. The following"
@echo "targets are available:"
@echo
@echo " help: Print this usage information."
Expand Down
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,26 @@
Image Builder
=============
# Image Builder console.redhat.com Middleware

Image Builder serves as an HTTP API on top of [Osbuild
Composer](https://github.com/osbuild/osbuild-composer), and serves as the
backend for [Image Builder
Frontend](https://github.com/osbuild/image-builder-frontend/).
"Image Builder **C**onsole.**R**edhat.**C**om" serves as
an HTTP API on top of [Osbuild Composer](https://github.com/osbuild/osbuild-composer),
and serves as the backend for [Image Builder Frontend](https://github.com/osbuild/image-builder-frontend/).

Image Builder is intended to be run within the
Image Builder Middleware is intended to be run within the
[console.redhat.com](https://console.redhat.com) platform.

### Project

* **Website**: <https://www.osbuild.org>
* **Bug Tracker**: <https://github.com/osbuild/image-builder/issues>
* **Bug Tracker**: <https://github.com/osbuild/image-builder-crc/issues>
* **Discussions**: https://github.com/orgs/osbuild/discussions
* **Matrix**: [#image-builder on fedoraproject.org](https://matrix.to/#/#image-builder:fedoraproject.org)
* **Changelog**: <https://github.com/osbuild/image-builder/releases>
* **Changelog**: <https://github.com/osbuild/image-builder-crc/releases>

### OpenAPI spec

The latest OpenAPI specification:

* [raw YAML](https://github.com/osbuild/image-builder/blob/main/internal/v1/api.yaml)
* [on-line version](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/osbuild/image-builder/main/internal/v1/api.yaml)
* [raw YAML](https://github.com/osbuild/image-builder-crc/blob/main/internal/v1/api.yaml)
* [on-line version](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/osbuild/image-builder-crc/main/internal/v1/api.yaml)

### Contributing

Expand Down Expand Up @@ -54,9 +52,9 @@ To run the project use `make run` target

## Repository

- **web**: <https://github.com/osbuild/image-builder>
- **https**: `https://github.com/osbuild/image-builder.git`
- **ssh**: `[email protected]:osbuild/image-builder.git`
- **web**: <https://github.com/osbuild/image-builder-crc>
- **https**: `https://github.com/osbuild/image-builder-crc.git`
- **ssh**: `[email protected]:osbuild/image-builder-crc.git`

## License

Expand Down

0 comments on commit 725c4d6

Please sign in to comment.