Skip to content

Commit db446a9

Browse files
docs: update readme (#709)
1 parent 4caeb6c commit db446a9

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,23 @@
66

77
<!-- x-release-please-end -->
88

9-
The Increase Java SDK provides convenient access to the Increase REST API from applications written in Java. It includes helper classes with helpful types and documentation for every request and response property.
9+
The Increase Java SDK provides convenient access to the Increase REST API from applications written in Java.
1010

1111
The Increase Java SDK is similar to the Increase Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as `Optional` instead of nullable values, `Stream` instead of `Sequence`, and `CompletableFuture` instead of suspend functions.
1212

13-
## Documentation
13+
The REST API documentation can be found on [increase.com](https://increase.com/documentation).
1414

15-
The REST API documentation can be found on [increase.com](https://increase.com/documentation).
16-
17-
---
18-
19-
## Getting started
20-
21-
### Install dependencies
22-
23-
#### Gradle
15+
## Installation
2416

2517
<!-- x-release-please-start-version -->
2618

19+
### Gradle
20+
2721
```kotlin
2822
implementation("com.increase.api:increase-java:0.164.0")
2923
```
3024

31-
#### Maven
25+
### Maven
3226

3327
```xml
3428
<dependency>
@@ -40,6 +34,8 @@ implementation("com.increase.api:increase-java:0.164.0")
4034

4135
<!-- x-release-please-end -->
4236

37+
## Usage
38+
4339
### Configure the client
4440

4541
Use `IncreaseOkHttpClient.builder()` to configure the client. At a minimum you need to set `.apiKey()`:

0 commit comments

Comments
 (0)