diff --git a/README.md b/README.md index 7eb41698..b7645893 100644 --- a/README.md +++ b/README.md @@ -22,17 +22,53 @@ regarding GraphQL Java itself. We try to stay up to date with GraphQL Java as much as possible maintaining the retro-compatibility with javax and Springframework 5. -On each release we publish two flavours of this project: - - the main one is using `jakarta` and Springframework `6.*` - - the legacy one is using `javax` and Springframework `5.*` +On each release we publish three flavours of this project: + - [latest jakarta](#jakarta-and-springframework-6) + - [jakarta5](#jakarta5) + - [javax](#javax-and-springframework-5) + +All of them also supports legacy projects that can compile with older JDK versions: the minimum JDK +version supported is the `11`. -On maven central you can distinguish them from the version because the `javax` flavor has the -suffix `-javax`. +## Jakarta and Springframework 6.* +This is the main flavour using the latest version of `Jakarta` (currently the `6.*`) and the latest +version of `Springframework` (currently the `6.*`). All the codebase can be found in the branch: +`master` -Both of them also supports legacy projects that can compile with older JDK versions: the oldest -supported one is the `11`. +```xml + + com.graphql-java-kickstart + graphql-java-servlet + ${graphql-java-servlet.version} + +``` + +## Jakarta5 +This flavour use the `jakarta` version `5.*` and it is meant to be used for all the projects that +are already migrated to jakarta, but they are waiting that `jakarta6` will become more broadly used. +All the codebase can be found in the branch: `jakarta5` + +```xml + + com.graphql-java-kickstart + graphql-java-servlet-jakarta5 + ${graphql-java-servlet-jakarta5.version} + +``` + +## Javax and Springframework 5.* +This is the legacy flavour using the `javax` dependency and the version `5.*` of `Springframework` +(since it is still broadly used by a lot of projects). All the codebase can be found in the branch: +`master` + +```xml + + com.graphql-java-kickstart + graphql-java-servlet-javax + ${graphql-java-servlet.version} + +``` -See [gradle.properties](gradle.properties) to see currently supported versions. ## Installation and getting started