diff --git a/README.md b/README.md index 6da4b724..6d528524 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,16 @@ # ChatGPT Telegram Bot ![python-version](https://img.shields.io/badge/python-3.10-blue.svg) -![playwright-version](https://img.shields.io/badge/playwright-1.28.0-green.svg) +![playwright-version](https://img.shields.io/badge/revChatGPT-0.0.23-green.svg) [![license](https://img.shields.io/badge/License-GPL%202.0-brightgreen.svg)](LICENSE) A [Telegram bot](https://core.telegram.org/bots/api) that integrates with OpenAI's [ChatGPT](https://openai.com/blog/chatgpt/) to provide answers. Ready to use with minimal configuration required. ## Screenshot -Demo +Demo ## Prerequisites -- Python 3.10+ -- [Pipenv](https://pipenv.readthedocs.io/en/latest/) -- A [Telegram bot](https://core.telegram.org/bots#6-botfather) and its token +- 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)) - An [OpenAI](https://openai.com) account (see [configuration](#configuration) section) ## Getting started @@ -42,12 +41,11 @@ OPENAI_PASSWORD="" TELEGRAM_BOT_TOKEN="" ``` You'll need to provide: -1. Your OpenAI credentials (these are only sent to the OpenAI server to periodically refresh the access token and never shared) - - Read more [here](https://github.com/acheong08/ChatGPT) +1. Your OpenAI credentials (these are only sent to the OpenAI server to periodically refresh the access token and never shared). You can read more about it [here](https://github.com/acheong08/ChatGPT) 2. Your Telegram bot's token, obtained using [BotFather](http://t.me/botfather) (see [tutorial](https://core.telegram.org/bots/tutorial#obtain-your-bot-token)) -### Run the project -Use the following command to run the project: +### Run +Use the following command to start the bot: ``` python main.py ```