Skip to content

Commit 425fe57

Browse files
committed
Updated README.md
1 parent c5438a1 commit 425fe57

File tree

1 file changed

+56
-4
lines changed

1 file changed

+56
-4
lines changed

README.md

Lines changed: 56 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,32 +113,84 @@ and some other optional features that ensure all load requests eventually comple
113113

114114
### Installing
115115

116-
No more talking. Let's install the `vertx-dataloader` dependency and look at some actual code!
116+
Gradle users configure the `vertx-dataloader` dependency in `build.gradle`:
117+
118+
```
119+
repositories {
120+
maven {
121+
jcenter()
122+
}
123+
}
124+
125+
dependencies {
126+
compile 'io.engagingspaces:vertx-dataloader:0.9.0'
127+
}
128+
```
117129

118130
### Building
119131

132+
To build from source use the Gradle wrapper:
133+
134+
```
135+
./gradlew clean build
136+
```
137+
138+
Or when using Maven add the following repository to your `pom.xml`:
139+
140+
```
141+
<repositories>
142+
<repository>
143+
<snapshots>
144+
<enabled>false</enabled>
145+
</snapshots>
146+
<id>central</id>
147+
<name>bintray</name>
148+
<url>http://jcenter.bintray.com</url>
149+
</repository>
150+
</repositories>
151+
```
152+
153+
And add the dependency to `vertx-dataloader`:
154+
155+
```
156+
<dependency>
157+
<groupId>io.engagingspaces</groupId>
158+
<artifactId>vertx-dataloader</artifactId>
159+
<version>0.9.0</version>
160+
<type>pom</type>
161+
</dependency>
162+
```
163+
120164
### Using
121165

166+
```java
167+
168+
```
169+
122170
### JavaDoc
123171

124172
## Project plans
125173

126174
### Current releases
127175

128-
- Not yet released
176+
- `1.0.0` Initial release
129177

130178
### Known issues
131179

132-
- **Work in progress...**but a `1.0.0` release is on its way!
133-
- Not yet production-ready as of yet, still porting tests that may uncover bugs.
134180
- Tests on job queue ordering need refactoring to Futures, one test currently omitted
135181

136182
### Upcoming features
137183

184+
- Distributed cache
185+
138186
### Future ideas
139187

188+
- `CompletableFuture` implementation
189+
140190
## Other information sources
141191

192+
- [Facebook DataLoader Github repo](https://github.com/facebook/dataloader)
193+
- [Facebook DataLoader code walkthrough on YouTube](https://youtu.be/OQTnXNCDywA)
142194
- [Using DataLoader and GraphQL to batch requests](http://gajus.com/blog/9/using-dataloader-to-batch-requests)
143195

144196
## Contributing

0 commit comments

Comments
 (0)