diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..59f24d0 --- /dev/null +++ b/readme.md @@ -0,0 +1,34 @@ +**Discord Image Description Bot** +===================================== + +**Overview** +----------- + +This Discord bot generates alt text for images in chat messages, providing a more inclusive experience for visually impaired users. + +**Features** +------------ + +* Automatically generates alt text for images when the "Describe Image(s)" context menu option is selected +* Supports various image formats, including JPEG, PNG and WEBP +* Easy to use: simply right-click on a message with an image and select "Describe Image(s)" + +**Setup** +--------- + +1. Invite the bot to your Discord server. +2. Ensure the bot has the necessary permissions to read and respond to messages. +3. Right-click on a message with an image and select "Describe Image(s)" to generate alt text. + +**Technical Details** +-------------------- + +* This bot uses a machine learning model to generate alt text. +* The model is trained on a large dataset of images and their corresponding descriptions. +* The bot responds with a message containing the generated alt text. + +**Troubleshooting** +----------------- + +* If the bot does not respond, ensure it has the necessary permissions and that the image is in a supported format. +* If the generated alt text is inaccurate, please try re-running the command or reporting the issue to the bot's developers. \ No newline at end of file