From 08f51d64220ed6f2429005734cd1f053169de376 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Sch=C3=BCnemann?= Date: Tue, 1 Jul 2025 10:50:39 +0200 Subject: [PATCH 1/2] docs: improve readme --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f11e96e..c90ab71 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,20 @@ ## About this project -Open Managed Control Planes +This repository contains the umbrella openMCP component, which is a collection of openMCP open-source components which can be deployed together to create an openMCP landscape. +The component is build with the [Open Component Model (OCM)](https://ocm.software). This component does not contain any resource definitions, but only references to other components. +The referenced components are defined in the file `component-constructor.yaml` in the root directory of this repository. +The versions of the referenced components are defined in the file `component-versions.yaml` in the root directory of this repository. ## Requirements and Setup -*Insert a short description what is required to get your project running...* +For accessing the openMCP component, the OCM CLI is required. The OCM CLI can be installed via the [OCM CLI documentation](https://ocm.software/docs/getting-started/installation/). +To view a specific version of the openMCP component inclusive all dependencies, use the following command: + +```bash +OPENMCP_VERSION=v0.0.7 +ocm get component --repo=OCIRegistry::ghcr.io/openmcp-project/components github.com/openmcp-project/openmcp:${OPENMCP_VERSION} -o yaml --recursive +``` ## Support, Feedback, Contributing From 113d0ea1754f18d625ffc5322c5c2c20100423d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Sch=C3=BCnemann?= Date: Tue, 1 Jul 2025 12:19:42 +0200 Subject: [PATCH 2/2] fix spelling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c90ab71..cf17e52 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ## About this project This repository contains the umbrella openMCP component, which is a collection of openMCP open-source components which can be deployed together to create an openMCP landscape. -The component is build with the [Open Component Model (OCM)](https://ocm.software). This component does not contain any resource definitions, but only references to other components. +The component is built with the [Open Component Model (OCM)](https://ocm.software). This component does not contain any resource definitions, but only references to other components. The referenced components are defined in the file `component-constructor.yaml` in the root directory of this repository. The versions of the referenced components are defined in the file `component-versions.yaml` in the root directory of this repository.