From e0ddd2264cf71940a31ae01c49c614edbd64aae6 Mon Sep 17 00:00:00 2001 From: ned Date: Thu, 8 Dec 2022 18:04:39 +0100 Subject: [PATCH] updated README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index f72a5d48..89e1e00e 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,27 @@ A [Telegram bot](https://core.telegram.org/bots/api) that integrates with OpenAI ## Screenshot Demo +## 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)) @@ -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