Skip to content

Commit 8e0f26e

Browse files
docs(readme): add a projects section
1 parent fe2532e commit 8e0f26e

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,9 @@ Discord user @pig#8932 has found a working `text-chat-davinci-002` model, `text-
102102
* [API Server](#api-server)
103103
* [CLI](#cli)
104104
* [Using a Reverse Proxy](#using-a-reverse-proxy)
105-
* [Caveats](#caveats)
105+
* [Projects](#projects)
106106
* [Web Client](#web-client)
107+
* [Caveats](#caveats)
107108
* [Contributing](#contributing)
108109
* [License](#license)
109110

@@ -435,17 +436,25 @@ Instructions are provided below.
435436
</details>
436437
</details>
437438

439+
## Projects
440+
🚀 A list of awesome projects using `@waylaidwanderer/chatgpt-api`:
441+
- [ChatGPT Web Client](https://github.com/waylaidwanderer/chatgpt-web-client): this is my web client using this project's API server, built using Nuxt 3. Also usable with other compatible API server implementations.
442+
- [ChatGPT Clone](https://github.com/danny-avila/chatgpt-clone): a clone of ChatGPT, uses official model, reverse-engineered UI, with AI model switching, message search, and prompt templates.
443+
444+
Add yours to the list by [editing this README](https://github.com/waylaidwanderer/node-chatgpt-api/edit/main/README.md) and creating a pull request!
445+
446+
## Web Client
447+
A web client is available for this project's API server is also available at [waylaidwanderer/chatgpt-web-client](https://github.com/waylaidwanderer/chatgpt-web-client).
448+
Or use one of the many projects listed above!
449+
438450
## Caveats
439451
### Regarding `ChatGPTClient`
440452
Since `gpt-3.5-turbo` is ChatGPT's underlying model, I had to do my best to replicate the way the official ChatGPT website uses it.
441453
This means my implementation or the underlying model may not behave exactly the same in some ways:
442454
- Conversations are not tied to any user IDs, so if that's important to you, you should implement your own user ID system.
443455
- ChatGPT's model parameters (temperature, frequency penalty, etc.) are unknown, so I set some defaults that I thought would be reasonable.
444456
- Conversations are limited to roughly the last 3000 tokens, so earlier messages may be forgotten during longer conversations.
445-
- This works in a similar way to ChatGPT, except I'm pretty sure they have some additional way of retrieving context from earlier messages when needed (which can probably be achieved with embeddings, but I consider that out-of-scope for now).
446-
447-
## Web Client
448-
A web client is available for this library's API server is also available at [waylaidwanderer/chatgpt-web-client](https://github.com/waylaidwanderer/chatgpt-web-client).
457+
- This works in a similar way to ChatGPT, except I'm pretty sure they have some additional way of retrieving context from earlier messages when needed (which can probably be achieved with embeddings, but I consider that out-of-scope for now).
449458

450459
## Contributing
451460
If you'd like to contribute to this project, please create a pull request with a detailed description of your changes.

0 commit comments

Comments
 (0)