Skip to content

Commit 1c7fc10

Browse files
docs: update readme (#152)
1 parent 462baf9 commit 1c7fc10

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
@@ -14,27 +14,21 @@
1414

1515
<!-- x-release-please-end -->
1616

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

19-
## Documentation
19+
The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs). Javadocs are also available on [javadoc.io](https://javadoc.io/doc/com.openai/openai-java/0.0.1).
2020

21-
The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs).
22-
23-
---
24-
25-
## Getting started
26-
27-
### Install dependencies
28-
29-
#### Gradle
21+
## Installation
3022

3123
<!-- x-release-please-start-version -->
3224

25+
### Gradle
26+
3327
```kotlin
3428
implementation("com.openai:openai-java:0.13.0")
3529
```
3630

37-
#### Maven
31+
### Maven
3832

3933
```xml
4034
<dependency>
@@ -46,6 +40,8 @@ implementation("com.openai:openai-java:0.13.0")
4640

4741
<!-- x-release-please-end -->
4842

43+
## Usage
44+
4945
### Configure the client
5046

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

0 commit comments

Comments
 (0)