Skip to content

Commit

Permalink
docs: update readme (#152)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-app[bot] committed Jan 24, 2025
1 parent 462baf9 commit 1c7fc10
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,21 @@

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

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.
The OpenAI Java SDK provides convenient access to the OpenAI REST API from applications written in Java.

## Documentation
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).

The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs).

---

## Getting started

### Install dependencies

#### Gradle
## Installation

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

### Gradle

```kotlin
implementation("com.openai:openai-java:0.13.0")
```

#### Maven
### Maven

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

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

## Usage

### Configure the client

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

0 comments on commit 1c7fc10

Please sign in to comment.