Skip to content

Commit 2ee0676

Browse files
committed
Add docs on grabbing the dependency from jCenter
1 parent 62b705a commit 2ee0676

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,30 @@
1-
Bol.com OpenAPI v4 java client
1+
bol.com OpenAPI v4 java client
22
===========================================
33

4-
Provides an easy way to communicate with the Bol.com OpenAPI v4.
4+
Provides an easy way to communicate with the bol.com OpenAPI v4.
55

66
The `client` is what you want to use as dependency of your project. The `client` provides the easy way of communicating. See [client README.md](subprojects/client/README.md) on how to use it.
77

8+
To get the bol.com OpenAPI client binaries, add the JCenter repository (https://bintray.com/bintray/jcenter) and the following dependency:
9+
10+
- Maven
11+
```
12+
<dependency>
13+
<groupId>com.bol.openapi</groupId>
14+
<artifactId>openapi-java-client</artifactId>
15+
<version>4.0.0</version>
16+
</dependency>
17+
```
18+
- Gradle
19+
```
20+
repositories {
21+
jcenter()
22+
}
23+
dependencies {
24+
compile 'com.bol.openapi:openapi-java-client:4.0.0'
25+
}
26+
```
27+
828
Usage
929
-----
1030

@@ -26,17 +46,16 @@ To be able to run the integration tests in your IDE, make sure the `OPENAPI_KEY`
2646
Requirements
2747
------------
2848
- Java 7+
29-
- A Bol.com developer key (which you can request at https://developers.bol.com)
49+
- A bol.com developer key (which you can request at https://developers.bol.com)
3050

3151
OpenAPI limitations
3252
-------------------
33-
(based on the Bol.com OpenAPI documentation)
53+
(based on the bol.com OpenAPI documentation)
3454

3555
- Max. 2000 requests per 60 minutes
3656
- Session lives for 20 minutes without activity
3757

3858
Todo
3959
====
40-
- Release to Maven Central/bintray
4160
- Extend to include all OpenAPI v4 functionality
4261
- Backport to OpenAPI v3

0 commit comments

Comments
 (0)