diff --git a/README.md b/README.md index 483fe93..f19fa3b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,28 @@ SymfonyCon Bot 2023 =================== -Chatbot for SymfonyCon 2023 +Chatbot for SymfonyCon 2023 with Telegram integration. + +Use it on Telegram: [@SymfonyConBot](https://t.me/SymfonyConBot) + +What's it about? +---------------- + +This bot is a small demo app for the SymfonyCon 2023 conference. +It's a simple bot that can be used to get information about the conference. +It knows a few things about the conference, like the dates, the location, and +the schedule. + +The bot demonstrates a simple way to implement Retrieval Augmented Generation +(RAG) with Symfony and OpenAI's API. + +Requirements +------------ + +* PHP 8.2 +* Doctrine compatible database engine +* [Symfony CLI](https://symfony.com/doc/master/cloud/getting-started#installing-the-cli-tool) (or sth similar) +* [Ngrok](https://ngrok.com/download) (or sth similar) +* [Telegram Bot Token](https://core.telegram.org/bots#6-botfather) +* [OpenAI API Key](https://platform.openai.com/docs/overview) +* [Pinecone API](https://www.pinecone.io/)