From ba97533bbe98271c53712a2e6e4aca693b7d5117 Mon Sep 17 00:00:00 2001 From: Silvio Giebl Date: Wed, 21 Feb 2024 23:06:09 +0100 Subject: [PATCH] Add dependency types section to README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d4033ae8..95ff63c7 100644 --- a/README.md +++ b/README.md @@ -193,6 +193,16 @@ The intersection of the supported platforms results in an assembled multi-arch O ![components-bundles-multi-arch.drawio.svg](docs/images/components-bundles-multi-arch.drawio.svg) +This plugin uses Gradle's model to represent the OCI component artifacts and dependencies. +It does not reinvent the dependency model. +Instead, it allows to use the same dependency types for declaring dependencies on OCI component artifacts as for declaring any other dependencies on e.g. Java libraries. +The following module dependency types can be used for OCI components: +- Project dependencies: depend on OCI components produced by other Gradle subprojects. +- External module dependencies: + - Can be downloaded from a repository that supports Gradle Module Metadata. + - Can also be downloaded from an OCI registry acting as a special kind of a repository. + - Can be substituted by project dependencies of included Gradle builds. + ### Fine-grained Configurability WIP