Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
n3d1117 committed Dec 8, 2022
1 parent 26cdd95 commit e0ddd22
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,27 @@ A [Telegram bot](https://core.telegram.org/bots/api) that integrates with OpenAI
## Screenshot
<img width="600" alt="Demo" src="https://user-images.githubusercontent.com/11541888/205654171-80359706-d2ef-4fac-8300-62fe448bfb55.png">

## Features
- [x] Reply to specific messages
- [x] Support markdown in answers
- [x] Can reset conversation thread with the `/reset` command
- [x] Typing indicator while generating a response
- [x] Access can be restricted by specifying a list of allowed users

## Additional Features - help needed!
- [ ] Multi-chat support
- Idea: cache different instances of `ChatGPT3Bot`, one for every chat id (maybe even persist them), so that every user has their own private conversation
- [ ] Support group chats
- Allow the bot to be used in group chats with specific commands
- [ ] Docker support
- With `Dockerfile` and `docker-compose.yml`. See [pull/2](https://github.com/n3d1117/chatgpt-telegram-bot/pull/2) for a start
- [ ] Advanced commands
- With premade ad-hoc prompts
- [ ] Token based authentication
- As an alternative to email/password authentication for those who signed up with other services (Google/Microsoft) or for those who get a `Captcha detected` error, see [#13](https://github.com/n3d1117/chatgpt-telegram-bot/issues/13)

PRs are always welcome!

## Prerequisites
- Python 3.10+ and [Pipenv](https://pipenv.readthedocs.io/en/latest/)
- A [Telegram bot](https://core.telegram.org/bots#6-botfather) and its token (see [tutorial](https://core.telegram.org/bots/tutorial#obtain-your-bot-token))
Expand Down Expand Up @@ -62,6 +83,7 @@ python main.py
## Credits
- [ChatGPT](https://chat.openai.com/chat) from [OpenAI](https://openai.com)
- [acheong08/ChatGPT](https://github.com/acheong08/ChatGPT) for reverse engineering ChatGPT APIs
- [rawandahmad698/PyChatGPT](https://github.com/rawandahmad698/PyChatGPT) for his work on the authentication protocol
- [python-telegram-bot](https://python-telegram-bot.org)

## Disclaimer
Expand Down

0 comments on commit e0ddd22

Please sign in to comment.