Skip to content

Commit cbcec3e

Browse files
committed
README.md improvements, extension, and corrections
1 parent 38c2af1 commit cbcec3e

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,24 +43,28 @@ and Nicholas Schrock (@schrockn) from [Facebook](https://www.facebook.com/), the
4343

4444
## Features
4545

46+
Vert.x `DataLoader` is a feature-complete port of the Facebook reference implementation with [one major difference](#manual-dispatching). These features are:
47+
4648
- Simple, intuitive API, using generics and fluent coding
4749
- Define batch load function with lambda expression
4850
- Schedule a load request in queue for batching
4951
- Add load requests from anywhere in code
5052
- Request returns [`Future<V>`](http://vertx.io/docs/apidocs/io/vertx/core/Future.html) of requested value
5153
- Can create multiple requests at once, returns [`CompositeFuture`](http://vertx.io/docs/apidocs/io/vertx/core/CompositeFuture.html)
5254
- Caches load requests, so data is only fetched once
53-
- Can clear individual cache keys, so data is fetched on next load request dispatch
55+
- Can clear individual cache keys, so data is fetched on next batch queue dispatch
5456
- Can prime the cache with key/values, to avoid data being fetched needlessly
5557
- Can configure cache key function with lambda expression to extract cache key from complex data loader key types
56-
- Dispatch load request queue when batch is prepared, returns `CompositeFuture`
57-
- Individual batch futures complete as batch is processed
58+
- Dispatch load request queue after batch is prepared, also returns [`CompositeFuture`](http://vertx.io/docs/apidocs/io/vertx/core/CompositeFuture.html)
59+
- Individual batch futures complete / resolve as batch is processed
5860
- `CompositeFuture`s results are ordered according to insertion order of load requests
5961
- Deals with partial errors when a batch future fails
6062
- Can disable batching and/or caching in configuration
6163
- 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
6264
- Has very high test coverage (see [Acknowledgements](#acknowlegdements))
6365

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

6670
### Manual dispatching
@@ -100,7 +104,8 @@ and some other optional features that ensure all load requests eventually comple
100104
### Additional features
101105

102106
- Initial release is a feature-complete port of the reference implementation (only change being [Manual dispatching](#manual-dispatching)).
103-
- See [Project plans](#project-plans) for upcoming features and ideas.
107+
- 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.
108+
- See [Project plans](#project-plans) for [upcoming features](#upcoming-features) and [future ideas](#future-ideas).
104109

105110
## Let's get started!
106111

0 commit comments

Comments
 (0)