Skip to content

Commit a8fdd93

Browse files
committed
Update README.md
1 parent d780322 commit a8fdd93

File tree

2 files changed

+32
-39
lines changed

2 files changed

+32
-39
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Question
4+
url: https://spectrum.chat/graphql-java-kick/tools
5+
about: If you have a question ask it on Spectrum. All questions on GitHub will be deleted.

README.md

Lines changed: 27 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,48 @@
22

33
[![TravisCI Build](https://travis-ci.org/graphql-java-kickstart/graphql-java-tools.svg?branch=master)](https://travis-ci.org/graphql-java-kickstart/graphql-java-tools)
44
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.graphql-java-kickstart/graphql-java-tools/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.graphql-java-kickstart/graphql-java-tools)
5-
[![Chat on Slack](https://img.shields.io/badge/slack-join%20chat-informational)](https://graphqljavakickstart.slack.com)
5+
[![Chat on Spectrum](https://img.shields.io/badge/spectrum-join%20the%20community-%23800080)](https://spectrum.chat/graphql-java-kick/tools)
66

77
This library allows you to use the GraphQL schema language to build your [graphql-java](https://github.com/graphql-java/graphql-java) schema.
88
Inspired by [graphql-tools](https://github.com/apollographql/graphql-tools), it parses the given GraphQL schema and allows you to BYOO (bring your own object) to fill in the implementations.
9-
GraphQL Java Tools works extremely well if you already have domain POJOs that hold your data (e.g. for RPC, ORM, REST, etc) by allowing you to map these magically to GraphQL objects.
9+
GraphQL Java Tools works well if you already have domain POJOs that hold your data (e.g. for RPC, ORM, REST, etc) by allowing you to map these "magically" to GraphQL objects.
1010

1111
GraphQL Java Tools aims for seamless integration with Java, but works for any JVM language. Try it with Kotlin!
1212

13-
## WARNING: NoClassDefFoundError when using Spring Boot
14-
15-
If you're using `graphl-java-tools` with Spring Boot version lower than 2.2 you need to set the `kotlin.version` in
16-
your Spring Boot project explicitly to version 1.3.70, because Spring Boot Starter parent currently overrides it with
17-
a 1.2.* version of Kotlin.
18-
`graphql-java-tools` requires 1.3.* however because of its coroutine support. If you don't override this version
19-
you will run into a `NoClassDefFoundError`.
2013

21-
Spring Boot team has indicated the Kotlin version will be upgraded to 1.3 in Spring Boot 2.2.
14+
## Quick start
2215

2316
### Using Gradle
24-
Set the Kotlin version in your `gradle.properties`
17+
Set the Kotlin version in your `gradle.properties`:
2518
```
2619
kotlin.version=1.3.70
2720
```
2821

22+
Add the dependency:
23+
```groovy
24+
compile 'com.graphql-java-kickstart:graphql-java-tools:6.2.0'
25+
```
26+
2927
### Using Maven
30-
Set the Kotlin version in your `<properties>` section
28+
Set the Kotlin version in your `<properties>` section:
3129
```xml
3230
<properties>
3331
<kotlin.version>1.3.70</kotlin.version>
3432
</properties>
3533
```
3634

35+
Add the dependency:
36+
```xml
37+
<dependency>
38+
<groupId>com.graphql-java-kickstart</groupId>
39+
<artifactId>graphql-java-tools</artifactId>
40+
<version>6.2.0</version>
41+
</dependency>
42+
```
43+
3744
## Documentation
3845

39-
Take a look at our new [documentation](https://www.graphql-java-kickstart.com/tools/) for more details.
46+
Take a look at our [documentation](https://www.graphql-java-kickstart.com/tools/) for more details.
4047

4148
## Why GraphQL Java Tools?
4249

@@ -49,31 +56,12 @@ A few libraries exist to ease the boilerplate pain, including [GraphQL-Java's bu
4956
* **Class Validation**: Since there aren't any compile-time checks of the type->class relationship, GraphQL Java Tools will warn you if you provide classes/types that you don't need to, as well as erroring if you use the wrong Java class for a certain GraphQL type when it builds the schema.
5057
* **Unit Testing**: Since your GraphQL schema is independent of your data model, this makes your classes simple and extremely testable.
5158

52-
## Build with Maven or Gradle
59+
## WARNING: NoClassDefFoundError when using Spring Boot
5360

54-
```xml
55-
<dependency>
56-
<groupId>com.graphql-java-kickstart</groupId>
57-
<artifactId>graphql-java-tools</artifactId>
58-
<version>6.2.0</version>
59-
</dependency>
60-
```
61-
```groovy
62-
compile 'com.graphql-java-kickstart:graphql-java-tools:6.0.2'
63-
```
61+
If you're using `graphl-java-tools` with Spring Boot version lower than 2.2 you need to set the `kotlin.version` in
62+
your Spring Boot project explicitly to version 1.3.70, because Spring Boot Starter parent currently overrides it with
63+
a 1.2.* version of Kotlin.
64+
`graphql-java-tools` requires 1.3.* however because of its coroutine support. If you don't override this version
65+
you will run into a `NoClassDefFoundError`.
6466

65-
New releases will be available faster in the JCenter repository than in Maven Central. Add the following to use for Maven
66-
```xml
67-
<repositories>
68-
<repository>
69-
<id>jcenter</id>
70-
<url>https://jcenter.bintray.com/</url>
71-
</repository>
72-
</repositories>
73-
```
74-
For Gradle:
75-
```groovy
76-
repositories {
77-
jcenter()
78-
}
79-
```
67+
Spring Boot team has indicated the Kotlin version will be upgraded to 1.3 in Spring Boot 2.2.

0 commit comments

Comments
 (0)