Skip to content

Commit 38f62ff

Browse files
authored
docs: update README (#312)
Signed-off-by: kvmw <[email protected]>
1 parent 0f8c16d commit 38f62ff

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

README.adoc

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Java CFEnv image:https://build.spring.io/plugins/servlet/wittified/build-status/CFENV-BMASTER[Build Status, link=https://build.spring.io/browse/CFENV-BMASTER]
1+
= Java CFEnv image:https://github.com/pivotal-cf/java-cfenv/actions/workflows/build.yml/badge.svg[Build Status, link=https://github.com/pivotal-cf/java-cfenv/actions/workflows/build.yml] image:https://img.shields.io/maven-central/v/io.pivotal.cfenv/java-cfenv-boot.svg[Maven Central, link=https://search.maven.org/artifact/io.pivotal.cfenv/java-cfenv-boot]
22

33
Java CFEnv is a library for easily accessing the environment variables set when deploying an application to Cloud Foundry.
44
It is modeled after the design of the node library https://github.com/cloudfoundry-community/node-cfenv/[node-cfenv] and other `-cfenv` libraries in the Cloud Foundry ecosystem.
@@ -9,33 +9,38 @@ CFEnv's Boot support sets https://docs.spring.io/spring-boot/docs/current/refere
99

1010
The https://spring.io/blog/2019/02/15/introducing-java-cfenv-a-new-library-for-accessing-cloud-foundry-services[1.0 M1 blog] provides some additional background information.
1111

12-
== Compatibility
13-
=== https://github.com/pivotal-cf/java-cfenv/tree/main[3.x]
12+
== Compatibility Matrix
1413

15-
* https://projects.spring.io/spring-framework/[Spring Framework] 6.x
14+
[cols="1,1,1,1,1"]
15+
|===
16+
| Java CFEnv | Spring Boot | Spring Framework | JDK | Notes
1617

17-
* https://projects.spring.io/spring-boot/[Spring Boot] 3.x
18-
19-
20-
=== https://github.com/pivotal-cf/java-cfenv/tree/2.5.x[2.x]
21-
22-
* https://projects.spring.io/spring-framework/[Spring Framework] 5.3+
23-
24-
* https://projects.spring.io/spring-boot/[Spring Boot] 2.5+
18+
| *3.x* | *3.x* | *6.x* | *17* |
19+
| 2.x | 2.5+ | 5.3+ | 8 | ⚠️ EOL
20+
|===
2521

2622
== Dependency Info
2723

2824
You can access the stable release from maven central using the coordinates
2925

26+
=== Maven
27+
3028
[source,xml]
3129
----
3230
<dependency>
3331
<groupId>io.pivotal.cfenv</groupId>
3432
<artifactId>java-cfenv-boot</artifactId>
35-
<version>3.1.3</version>
33+
<version>${version}</version>
3634
</dependency>
3735
----
3836

37+
=== Gradle
38+
39+
[source,groovy]
40+
----
41+
implementation 'io.pivotal.cfenv:java-cfenv-boot:${version}'
42+
----
43+
3944
== SCS and SSO modules
4045
If you're attempting to connect a client app to a https://docs.pivotal.io/spring-cloud-services/3-1/common/client-dependencies.html[Spring Cloud Services] or https://docs.pivotal.io/p-identity/1-11/integrating-sso.html[Single Sign-On] service instance, you should follow their respective docs.
4146

0 commit comments

Comments
 (0)