Skip to content

Commit 37ee063

Browse files
committed
Updated README for 1.0.0
1 parent 807a454 commit 37ee063

File tree

1 file changed

+8
-20
lines changed

1 file changed

+8
-20
lines changed

README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ An important use case for `DataLoader` is improving the efficiency of GraphQL qu
1515
many other use cases where you can benefit from using this utility.
1616

1717
Most of the code is ported directly from Facebook's reference implementation, with one IMPORTANT adaptation to make
18-
it work for Java 8 and Vert.x. ([Find more on this in the paragraphs below]).
18+
it work for Java 8 and Vert.x. ([more on this below](manual-dispatching)).
1919

2020
But before reading on, be sure to take a short dive into the
2121
[original documentation](https://github.com/facebook/dataloader/blob/master/README.md) provided by Lee Byron (@leebyron)
@@ -26,14 +26,12 @@ and Nicholas Schrock (@schrockn) from [Facebook](https://www.facebook.com/), the
2626
- [Features](#features)
2727
- [Differences to reference implementation](#differences-to-reference-implementation)
2828
- [Manual dispatching](#manual-dispatching)
29-
- [Additional features!](#additional-features)
3029
- [Let's get started!](#lets-get-started)
3130
- [Installing](#installing)
3231
- [Building](#building)
3332
- [Project plans](#project-plans)
3433
- [Current releases](#current-releases)
3534
- [Known issues](#known-issues)
36-
- [Upcoming features](#upcoming-features)
3735
- [Future ideas](#future-ideas)
3836
- [Other information sources](#other-information-sources)
3937
- [Contributing](#contributing)
@@ -62,8 +60,6 @@ Vert.x `DataLoader` is a feature-complete port of the Facebook reference impleme
6260
- Can supply your own [`CacheMap<K, V>`](https://github.com/engagingspaces/vertx-dataloader/blob/master/src/main/java/io/engagingspaces/vertx/dataloader/CacheMap.java) implementations
6361
- Has very high test coverage (see [Acknowledgements](#acknowlegdements))
6462

65-
Then Vert.x `DataLoader` has some very interesting [Additional features](#additional-features) that result from it being based on Vert.x
66-
6763
## Differences to reference implementation
6864

6965
### Manual dispatching
@@ -97,15 +93,6 @@ and there are also gains to this different mode of operation:
9793
However, with batch execution control comes responsibility! If you forget to make the call to `dispatch()` then the futures
9894
in the load request queue will never be batched, and thus _will never complete_! So be careful when crafting your loader designs.
9995

100-
**Note**: In future releases the danger of not invoking dispatch will be greatly diminished. There will be an optional dispatch timeout,
101-
and some other optional features that ensure all load requests eventually complete. See [Project plans](#project-plans) for upcoming features and ideas.
102-
103-
### Additional features
104-
105-
- Initial release is a feature-complete port of the reference implementation (only change being [Manual dispatching](#manual-dispatching)).
106-
- Sorry, no additional features yet :flushed:, but this is where _you_ :hand: come into the picture: By giving your [feedback](https://github.com/vertx-dataloader/issues) and [contribute](#contributing)! You are most welcome.
107-
- See [Project plans](#project-plans) for [upcoming features](#upcoming-features) and [future ideas](#future-ideas).
108-
10996
## Let's get started!
11097

11198
### Installing
@@ -120,7 +107,7 @@ repositories {
120107
}
121108
122109
dependencies {
123-
compile 'io.engagingspaces:vertx-dataloader:0.9.0'
110+
compile 'io.engagingspaces:vertx-dataloader:1.0.0'
124111
}
125112
```
126113

@@ -153,11 +140,16 @@ And add the dependency to `vertx-dataloader`:
153140
<dependency>
154141
<groupId>io.engagingspaces</groupId>
155142
<artifactId>vertx-dataloader</artifactId>
156-
<version>0.9.0</version>
143+
<version>1.0.0</version>
157144
<type>pom</type>
158145
</dependency>
159146
```
160147

148+
### Using
149+
150+
Please take a look at the example project [vertx-graphql-example](https://github.com/bmsantos/vertx-graphql-example)
151+
created by [Bruno Santos](https://github.com/bmsantos).
152+
161153
## Project plans
162154

163155
### Current releases
@@ -168,10 +160,6 @@ And add the dependency to `vertx-dataloader`:
168160

169161
- Tests on job queue ordering need refactoring to Futures, one test currently omitted
170162

171-
### Upcoming features
172-
173-
- Distributed cache
174-
175163
### Future ideas
176164

177165
- `CompletableFuture` implementation

0 commit comments

Comments
 (0)