diff --git a/examples/README.md b/examples/README.md index 1eda260c5..72399d621 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,38 +1,3 @@ # Example Apps Made with the Agents API -This directory contains sample applications demonstrating how to use the Agents API effectively. Each example is designed to showcase different aspects of the API, providing a practical approach to learning and implementing its features. - -## Discord Bot Example - -This example demonstrates how to create a Discord bot using the Agents API, focusing on real-time interactions and automation within Discord servers. - -### Getting Started - -To set up this example, you'll need to install the necessary dependencies as listed in the `discord-bot/pyproject.toml` file. This includes: - -- Python 3.10 or higher -- discord.py library -- Other dependencies as specified - -To install these dependencies, run: - -```bash -poetry install -``` - -### Running the Example - -1. Follow the bot account setup instructions linked in the `discord-bot/README.md`. -2. Set the Discord bot token and GIPHY API key as environment variables. -3. Start the bot by running: - -```bash -python bot.py -``` - -### Additional Notes - -- Ensure you have the correct permissions set for your bot in the Discord developer portal. -- Refer to the `discord-bot/README.md` for troubleshooting common issues. - -We encourage you to explore these examples and experiment with the Agents API to learn more about its capabilities. +This is a collection of templates and apps showcasing the functionality of the Agents API