From 1c7fc10590f80090e1143d2fe3c77aed4c363519 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 22 Jan 2025 19:19:28 +0000 Subject: [PATCH] docs: update readme (#152) --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0a0be592..f115970f 100644 --- a/README.md +++ b/README.md @@ -14,27 +14,21 @@ -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 +### Gradle + ```kotlin implementation("com.openai:openai-java:0.13.0") ``` -#### Maven +### Maven ```xml @@ -46,6 +40,8 @@ implementation("com.openai:openai-java:0.13.0") +## Usage + ### Configure the client Use `OpenAIOkHttpClient.builder()` to configure the client. At a minimum you need to set `.apiKey()`: