diff --git a/README.adoc b/README.adoc index 28237ec1d..51737f8d2 100644 --- a/README.adoc +++ b/README.adoc @@ -10,9 +10,9 @@ image:https://img.shields.io/maven-central/v/io.smallrye.config/smallrye-config? = SmallRye Config *SmallRye Config* is a library that provides a way to configure applications, frameworks and containers. It is used -in applications servers like https://wildfly.org/[WildFly] and https://openliberty.io[Open Liberty], or frameworks -like https://quarkus.io[Quarkus]. It can also be used completely standalone in any Java application, which makes it a -very flexible library. +in applications servers like https://wildfly.org/[WildFly], https://openliberty.io[Open Liberty] and +https://tomee.apache.org[TomEE], or frameworks like https://quarkus.io[Quarkus]. It can also be used completely +standalone in any Java application, which makes it a very flexible library. It follows the https://github.com/eclipse/microprofile-config/[MicroProfile Config] specification to provide the initial config foundations and expands with it own concepts to cover a wide range of use cases observed in the diff --git a/documentation/src/main/docs/index.md b/documentation/src/main/docs/index.md index 659c2a518..679597547 100644 --- a/documentation/src/main/docs/index.md +++ b/documentation/src/main/docs/index.md @@ -7,9 +7,9 @@ hide: # SmallRye Config **SmallRye Config** is a library that provides a way to configure applications, frameworks and containers. It is used -in applications servers like [WildFly](https://wildfly.org/) and [Open Liberty](https://openliberty.io), or frameworks -like [Quarkus](https://quarkus.io). It can also be used completely standalone in any Java application, which makes it a -very flexible library. +in applications servers like [WildFly](https://wildfly.org/), [Open Liberty](https://openliberty.io) and +[TomEE](https://tomee.apache.org) or frameworks like [Quarkus](https://quarkus.io). It can also be used completely +standalone in any Java application, which makes it a very flexible library. It follows the [MicroProfile Config](https://github.com/eclipse/microprofile-config/) specification to provide the initial config foundations and expands with it own concepts to cover a wide range of use cases observed in the @@ -53,6 +53,17 @@ And retrieve a `SmallRyeConfig` instance with: SmallRyeConfig config = ConfigProvider.getConfig().unwrap(SmallRyeConfig.class); ``` +!!! info + + The `SmallRyeConfig` instance will be created and registered to the context class loader if no such configuration + is already created and registered. + +Or build your own: + +```java +SmallRyeConfig config = new SmallRyeConfigBuilder().build(); +``` + !!! info `SmallRyeConfig` is the entry point to all the config capabilities provided by SmallRye Config. diff --git a/implementation/pom.xml b/implementation/pom.xml index 4cef4bed0..8088e1450 100644 --- a/implementation/pom.xml +++ b/implementation/pom.xml @@ -35,7 +35,6 @@ jakarta.annotation jakarta.annotation-api - provided io.smallrye.common