Skip to content

Commit a9f6ec6

Browse files
authored
Merge pull request #48 from setchy/feature/docs-java-primitives
Update readme for java primitive scalars and v17 release
2 parents aff4d46 + 97088a0 commit a9f6ec6

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

readme.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Extended Scalars for graphql-java
22

33
[![Build Status](https://github.com/graphql-java/graphql-java-extended-scalars/actions/workflows/master.yml/badge.svg)](https://github.com/graphql-java/graphql-java-extended-scalars/actions/workflows/master.yml)
4-
[![Latest Release](https://maven-badges.herokuapp.com/maven-central/com.graphql-java/graphql-java-extended-scalars/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.graphql-java/graphql-java-extended-scalars/)
4+
[![Latest Release](https://img.shields.io/maven-central/v/com.graphql-java/graphql-java-extended-scalars?versionPrefix=17)](https://maven-badges.herokuapp.com/maven-central/com.graphql-java/graphql-java-extended-scalars/)
55
[![MIT licensed](https://img.shields.io/badge/license-MIT-green)](https://github.com/graphql-java/graphql-java-extended-scalars/blob/master/LICENSE.md)
66

77

88
This library provides extended scalars for [graphql-java](https://github.com/graphql-java/graphql-java)
99

10-
Scalars in graphql are the leaf nodes of a query, the non compound values that cant be queried further via sub field selections.
10+
Scalars in graphql are the leaf nodes of a query, the non-compound values that can't be queried further via sub-field selections.
1111

1212
The graphql standard specifies that the `String`, `Int`, `Float`, `Boolean` and `ID` scalars must be present in a graphql type
1313
system but after that it is up to an implementation about what custom scalars are present.
@@ -16,14 +16,14 @@ You would use custom scalars when you want to describe more meaningful behavior
1616

1717
To use this library put the following into your gradle config
1818

19-
compile 'com.graphql-java:graphql-java-extended-scalars:16.0.0'
19+
compile 'com.graphql-java:graphql-java-extended-scalars:17.0.0'
2020

2121
or the following into your Maven config
2222

2323
<dependency>
2424
<groupId>com.graphql-java</groupId>
2525
<artifactId>graphql-java-extended-scalars</artifactId>
26-
<version>16.0.0</version>
26+
<version>17.0.0</version>
2727
</dependency>
2828

2929
> Note:
@@ -33,8 +33,10 @@ or the following into your Maven config
3333
> use 15.0.0 or above for graphql-java 15.x and above
3434
>
3535
> use 16.0.0 or above for graphql-java 16.x and above
36+
>
37+
> use 17.0 or above for graphql-java 17.x and above
3638
37-
Its currently available from JCenter repo and Maven central.
39+
It's currently available from Maven Central.
3840

3941
Then register the scalar with graphql-java
4042

@@ -277,6 +279,21 @@ And use it in a SDL schema like this :
277279

278280
Note: A future version of the graphql specification may add this capability but in the meantime you can use this facility.
279281

282+
## Java Primitives
283+
* `GraphQLLong`
284+
* A scalar which represents `java.lang.Long`
285+
* `GraphQLShort`
286+
* A scalar which represents `java.lang.Short`
287+
* `GraphQLByte`
288+
* A scalar which represents `java.lang.Byte`
289+
* `GraphQLBigDecimal`
290+
* A scalar which represents `java.math.BigDecimal`
291+
* `GraphQLBigInteger`
292+
* A scalar which represents `java.math.BigInteger`
293+
* `GraphQLChar`
294+
* A scalar which represents `java.lang.Character`
295+
296+
280297
## Other Scalars
281298

282299
* `Url`

0 commit comments

Comments
 (0)