Skip to content

Commit

Permalink
Fix README typos
Browse files Browse the repository at this point in the history
  • Loading branch information
razor-x committed Nov 10, 2023
1 parent 92281aa commit 95d5db1
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,17 +194,20 @@ const seam = SeamHttp.fromApiKey('some-api-key', {
#### Setting the endpoint

Some contexts may need to override the API endpoint,
e.g., testing or proxy setup.
This option corresponds to the setting Axios `baseURL`.
e.g., testing or proxy setups.
This option corresponds to the Axios `baseURL` setting.

Either pass the `endpoint` option, or set the `SEAM_ENDPOINT` environment variable.

#### Configuring the Axios Client

The Axios client and retry behavior may be configured with custom initiation options
via `axiosOptions` and `axiosRetryOptions`.
via [`axiosOptions`] and [`axiosRetryOptions`][axiosRetryOptions].
Options are deep merged with the default options.

[axiosOptions]: https://axios-http.com/docs/config_defaults
[axiosRetryOptions]: https://github.com/softonic/axios-retry

#### Using the Axios Client

The Axios client is exposed and may be used or configured directly:
Expand Down

0 comments on commit 95d5db1

Please sign in to comment.