Skip to content

Commit cb5c2da

Browse files
committed
Move from readme to documentation
1 parent 4f18d90 commit cb5c2da

File tree

1 file changed

+1
-68
lines changed

1 file changed

+1
-68
lines changed

README.md

Lines changed: 1 addition & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -13,77 +13,10 @@ We try to stay up to date with GraphQL Java as much as possible. The current ver
1313

1414
This project requires at least Java 8.
1515

16-
## Quick start
16+
## Installation and getting started
1717

1818
See [Getting started](https://www.graphql-java-kickstart.com/servlet/getting-started/) for more detailed instructions.
1919

20-
To add `graphql-java-servlet` to your project and get started quickly, do the following.
21-
22-
### Build with Gradle
23-
24-
Make sure `mavenCentral` is amongst your repositories:
25-
```gradle
26-
repositories {
27-
mavenCentral()
28-
}
29-
```
30-
31-
Add the `graphql-java-servlet` dependency:
32-
```gradle
33-
dependencies {
34-
compile 'com.graphql-java-kickstart:graphql-java-servlet:9.1.0'
35-
}
36-
```
37-
38-
### Build with Maven
39-
40-
Add the `graphql-java-servlet` dependency:
41-
```xml
42-
<dependency>
43-
<groupId>com.graphql-java-kickstart</groupId>
44-
<artifactId>graphql-java-servlet</artifactId>
45-
<version>9.1.0</version>
46-
</dependency>
47-
```
48-
49-
### Create a Servlet class
50-
51-
Creating the Servlet class requires various parameters to be provided at the moment. We're working on simplifying
52-
this, to make it easier to get started. For now, take a look at [Create a Servlet class](https://www.graphql-java-kickstart.com/servlet/getting-started/#create-a-servlet-class)
53-
to see what's needed to create a Servlet with a schema.
54-
55-
## Using the latest development build
56-
57-
Snapshot versions of the current `master` branch are available on JFrog. Check the next snapshot version in
58-
[gradle.properties](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/gradle.properties).
59-
60-
### Build with Gradle
61-
62-
Add the Snapshot repository:
63-
```gradle
64-
repositories {
65-
mavenCentral()
66-
maven { url "http://oss.jfrog.org/artifactory/oss-snapshot-local" }
67-
}
68-
```
69-
70-
### Build with Maven
71-
72-
Add the Snapshot repository:
73-
```xml
74-
<repositories>
75-
<repository>
76-
<id>oss-snapshot-local</id>
77-
<name>jfrog</name>
78-
<url>http://oss.jfrog.org/artifactory/oss-snapshot-local</url>
79-
<snapshots>
80-
<enabled>true</enabled>
81-
<updatePolicy>always</updatePolicy>
82-
</snapshots>
83-
</repository>
84-
</repositories>
85-
```
86-
8720
# Usage
8821

8922
The servlet supports the following request formats:

0 commit comments

Comments
 (0)