Skip to content

fix: Revise README.md for clarity and completeness #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adambkaplan merged 1 commit into from
Sep 25, 2025
Merged

fix: Revise README.md for clarity and completeness #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
<h2 align="center"><center>An extensible framework for
building container images in Kubernetes</center></h2>
building container images on Kubernetes</center></h2>

## Projects

A few of the most popular libraries:
Below are the main components of Shipwright:

* [**build**](https://github.com/shipwright-io/build), A framework for building container images on Kubernetes
* [**operator**](https://github.com/shipwright-io/operator), An operator to install and configure Shipwright Builds on Kubernetes clusters
* [**triggers**](https://github.com/shipwright-io/triggers), Event-driven Shipwright Builds
* [**cli**](https://github.com/shipwright-io/cli), A CLI for building container images on Kubernetes
* [**community**](https://github.com/shipwright-io/community), Community documentation for Shipwright
* [**website**](https://github.com/shipwright-io/website), Source code for the shipwright.io website
* [**image**](https://github.com/shipwright-io/image), Shipwright Image APIs and Operators
* [**build**](https://github.com/shipwright-io/build): provides the core Build APIs for Shipwright.
* [**operator**](https://github.com/shipwright-io/operator): An operator to install and configure Shipwright on Kubernetes clusters.
* [**cli**](https://github.com/shipwright-io/cli): A CLI for building container images with Shipwright.
* [**triggers**](https://github.com/shipwright-io/triggers): Event-driven Shipwright Builds.

Documentation for Shipwright is maintained here:

* [**website**](https://github.com/shipwright-io/website): Content on the shipwright.io website.
* [**community**](https://github.com/shipwright-io/community): Commmunity process and governance documentation.

## Getting Started 📚

Expand Down