Skip to content

Commit

Permalink
Make jakarta.annotation-api compile scope so SmallRyeConfig can be us…
Browse files Browse the repository at this point in the history
…ed without any extra set up (#1193)
  • Loading branch information
radcortez authored Jul 4, 2024
1 parent 7903a3c commit c093a53
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 14 additions & 3 deletions documentation/src/main/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
1 change: 0 additions & 1 deletion implementation/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
<dependency>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>io.smallrye.common</groupId>
Expand Down

0 comments on commit c093a53

Please sign in to comment.