Skip to content

Commit

Permalink
feat: Updated examples/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sweep-ai[bot] authored Apr 17, 2024
1 parent 056158e commit baaddac
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
# Example Apps Made with the Agents API

This is a collection of templates and apps showcasing the functionality of 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.

0 comments on commit baaddac

Please sign in to comment.