Update readme

thmsmlr · Dec 19, 2023 · dc590a3 · dc590a3
1 parent 9c2d2bc
commit dc590a3
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -73,6 +73,8 @@ Simply create an ecto schema, optionally provide a `@doc` to the schema definiti
 
 ## Installation
 
+In your mix.exs,
+
 ```elixir
 def deps do
   [
@@ -81,6 +83,13 @@ def deps do
 end
 ```
 
+Then for configuration using the default OpenAI client,
+
+```elixir
+config :openai, api_key: "sk-........"
+config :openai, http_options: [recv_timeout: 10 * 60 * 1000]
+```
+
 ## TODO
 
 - [x] Tests

diff --git a/lib/instructor.ex b/lib/instructor.ex
@@ -11,6 +11,8 @@ defmodule Instructor do
     Instructor can be configured in your `config.exs` file:
 
         config :instructor, adapter: Instructor.Adapters.OpenAI
+        config :openai, api_key: "sk-........"
+        config :openai, http_options: [recv_timeout: 10 * 60 * 1000]
 
     Other adapters are Instructor.Adapters.Llamacpp
   """