Skip to content

Commit 80a2e6a

Browse files
authored
Merge pull request #530 from federicorispo/doc/update-readme
doc: update README.md describing all the released flavours
2 parents 1a8ca3c + eb37b60 commit 80a2e6a

File tree

1 file changed

+44
-8
lines changed

1 file changed

+44
-8
lines changed

README.md

+44-8
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,53 @@ regarding GraphQL Java itself.
2222
We try to stay up to date with GraphQL Java as much as possible maintaining the retro-compatibility
2323
with javax and Springframework 5.
2424

25-
On each release we publish two flavours of this project:
26-
- the main one is using `jakarta` and Springframework `6.*`
27-
- the legacy one is using `javax` and Springframework `5.*`
25+
On each release we publish three flavours of this project:
26+
- [latest jakarta](#jakarta-and-springframework-6)
27+
- [jakarta5](#jakarta5)
28+
- [javax](#javax-and-springframework-5)
29+
30+
All of them also supports legacy projects that can compile with older JDK versions: the minimum JDK
31+
version supported is the `11`.
2832

29-
On maven central you can distinguish them from the version because the `javax` flavor has the
30-
suffix `-javax`.
33+
## Jakarta and Springframework 6.*
34+
This is the main flavour using the latest version of `Jakarta` (currently the `6.*`) and the latest
35+
version of `Springframework` (currently the `6.*`). All the codebase can be found in the branch:
36+
`master`
3137

32-
Both of them also supports legacy projects that can compile with older JDK versions: the oldest
33-
supported one is the `11`.
38+
```xml
39+
<dependency>
40+
<groupId>com.graphql-java-kickstart</groupId>
41+
<artifactId>graphql-java-servlet</artifactId>
42+
<version>${graphql-java-servlet.version}</version>
43+
</dependency>
44+
```
45+
46+
## Jakarta5
47+
This flavour use the `jakarta` version `5.*` and it is meant to be used for all the projects that
48+
are already migrated to jakarta, but they are waiting that `jakarta6` will become more broadly used.
49+
All the codebase can be found in the branch: `jakarta5`
50+
51+
```xml
52+
<dependency>
53+
<groupId>com.graphql-java-kickstart</groupId>
54+
<artifactId>graphql-java-servlet-jakarta5</artifactId>
55+
<version>${graphql-java-servlet-jakarta5.version}</version>
56+
</dependency>
57+
```
58+
59+
## Javax and Springframework 5.*
60+
This is the legacy flavour using the `javax` dependency and the version `5.*` of `Springframework`
61+
(since it is still broadly used by a lot of projects). All the codebase can be found in the branch:
62+
`master`
63+
64+
```xml
65+
<dependency>
66+
<groupId>com.graphql-java-kickstart</groupId>
67+
<artifactId>graphql-java-servlet-javax</artifactId>
68+
<version>${graphql-java-servlet.version}</version>
69+
</dependency>
70+
```
3471

35-
See [gradle.properties](gradle.properties) to see currently supported versions.
3672

3773
## Installation and getting started
3874

0 commit comments

Comments
 (0)