Skip to content

Update README.md #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bbakerman merged 2 commits into from
Oct 22, 2021
Merged

Update README.md #103

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91b5603
Move getting started higher in README
lkorth Oct 19, 2021
e32e320
Update version in README to latest
lkorth Oct 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 27 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ and Nicholas Schrock (@schrockn) from [Facebook](https://www.facebook.com/), the
## Table of contents

- [Features](#features)
- [Examples](#examples)
- [Let's get started!](#lets-get-started)
- [Getting started!](#getting-started)
- [Installing](#installing)
- [Building](#building)
- [Examples](#examples)
- [Other information sources](#other-information-sources)
- [Contributing](#contributing)
- [Acknowledgements](#acknowledgements)
Expand Down Expand Up @@ -55,6 +55,31 @@ and Nicholas Schrock (@schrockn) from [Facebook](https://www.facebook.com/), the
- Can supply your own `ValueCache<K, V>` implementations
- Has very high test coverage

## Getting started!

### Installing

Gradle users configure the `java-dataloader` dependency in `build.gradle`:

```
repositories {
jcenter()
}

dependencies {
compile 'com.graphql-java:java-dataloader: 3.1.0'
}
```

### Building

To build from source use the Gradle wrapper:

```
./gradlew clean build
```


## Examples

A `DataLoader` object requires a `BatchLoader` function that is responsible for loading a promise of values given
Expand Down Expand Up @@ -513,30 +538,6 @@ since it was last dispatched".
The above acts as a kind of minimum batch depth, with a time overload. It won't dispatch if the loader depth is less
than or equal to 10 but if 200ms pass it will dispatch.

## Let's get started!

### Installing

Gradle users configure the `java-dataloader` dependency in `build.gradle`:

```
repositories {
jcenter()
}

dependencies {
compile 'com.graphql-java:java-dataloader: 2.2.3'
}
```

### Building

To build from source use the Gradle wrapper:

```
./gradlew clean build
```


## Other information sources

Expand Down