Skip to content

Commit f2c660f

Browse files
committed
Added TravisCI and Apache-licensed shields to README.md
1 parent d92472c commit f2c660f

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Vert.x `DataLoader`
22

3+
[![Build Status](https://travis-ci.org/engagingspaces/vertx-dataloader.svg?branch=master)](https://travis-ci.org/engagingspaces/vertx-dataloader/)  
4+
[![Apache licensed](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000)](https://github.com/engagingspaces/vertx-dataloader/blob/master/LICENSE)  
5+
36
**More documentation coming soon..**
47

58
This small and simple utility library is a port of [Facebook DataLoader](https://github.com/facebook/dataloader)
@@ -72,7 +75,7 @@ distributed [`EventBus`](http://vertx.io/docs/vertx-core/java/#event_bus) that m
7275
Now in NodeJS generates so-call 'ticks' in which queued functions are dispatched for execution, and Facebook `DataLoader` uses
7376
the `nextTick()` function in NodeJS to _automatically_ dequeue load requests and send them to the batch execution function for processing.
7477

75-
And here there is an *IMPORTANT DIFFERENCE* compared to how _this_ data loader operates!!
78+
And here there is an **IMPORTANT DIFFERENCE** compared to how _this_ data loader operates!!
7679

7780
In NodeJS the batch preparation will not affect the asynchronous processing behaviour in any way. It will just prepare
7881
batches in 'spare time' as it were.
@@ -90,12 +93,12 @@ and there are also gains to this different mode of operation:
9093
However, with batch execution control comes responsibility! If you forget to make the call to `dispatch()` then the futures
9194
in the load request queue will never be batched, and thus _will never complete_! So be careful when crafting your loader designs.
9295

93-
*Note*: In future releases the danger of not invoking dispatch will be greatly diminished. There will be an optional dispatch timeout,
96+
**Note**: In future releases the danger of not invoking dispatch will be greatly diminished. There will be an optional dispatch timeout,
9497
and some other optional features that ensure all load requests eventually complete. See [Project plans](#project-plans) for upcoming features and ideas.
9598

9699
### Additional features
97100

98-
- Initial release is a feature-complete port of the reference implementation (with the only change being [Manual dispatching](#manual-dispatching)).
101+
- Initial release is a feature-complete port of the reference implementation (only change being [Manual dispatching](#manual-dispatching)).
99102
- See [Project plans](#project-plans) for upcoming features and ideas.
100103

101104
## Let's get started!

0 commit comments

Comments
 (0)