Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
Close #2
  • Loading branch information
johnd0e committed Mar 2, 2024
1 parent 87c8d08 commit b0f7f05
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions readme.MD
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,31 @@ which is necessary for continuous integration (CI).
- _Worker_ [limits](https://developers.cloudflare.com/workers/platform/limits/#worker-limits)

## How to use
If you open your newly-deployed site in a browser, you will only see a `404 Not Found` message. This is expected, as the API is not designed for direct browser access.
To utilize it, you should enter your API address and your Gemini API key into the corresponding fields in your software settings.

> [!NOTE]
> Not all tools allows overriding the OpenAI endpoint, but many do
> Not all software tools allow overriding the OpenAI endpoint, but many do
> (however these settings can sometimes be deeply hidden).
Use the endpoint address wherever you can specify it.
Typically, you should specify the API base in this format:
`https://my-super-proxy.vercel.app/v1`

However, some software may expect it without the `/v1` ending:
`https://my-super-proxy.vercel.app`

The relevant field may be labeled as "_OpenAI proxy_".
You might need to look under "_Advanced settings_" or similar sections.
Or in some config file.

For some command-line tools, you may need to set an environment variable, _e.g._:
`set OPENAI_BASE_URL=https://my-super-proxy.vercel.app/v1`
_..or_:
`set OPENAI_API_BASE=https://my-super-proxy.vercel.app/v1`
Alternatively, it could be in some config file (check the relevant documentation for details).

For some command-line tools, you may need to set an environment variable, _e.g._:
```sh
set OPENAI_BASE_URL=https://my-super-proxy.vercel.app/v1
```
_..or_:
```sh
set OPENAI_API_BASE=https://my-super-proxy.vercel.app/v1
```

---

Expand Down

0 comments on commit b0f7f05

Please sign in to comment.