docs(readme): add link to api.md (#291)

openai · Sep 6, 2023 · 0d1cce2 · 0d1cce2
1 parent a10b895
commit 0d1cce2
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -18,8 +18,7 @@ yarn add openai
 
 ## Usage
 
-> [!IMPORTANT]
-> Previous versions of this SDK used a `Configuration` class. See the [v3 to v4 migration guide](https://github.com/openai/openai-node/discussions/217).
+The full API of this library can be found in [api.md file](https://github.com/openai/openai-node/blob/master/api.md). The code below shows how to get started using the chat completions API.
 
 ```js
 import OpenAI from 'openai';
@@ -90,6 +89,9 @@ main();
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
 
+> [!IMPORTANT]
+> Previous versions of this SDK used a `Configuration` class. See the [v3 to v4 migration guide](https://github.com/openai/openai-node/discussions/217).
+
 ## File Uploads
 
 Request parameters that correspond to file uploads can be passed in many different forms: