From 9b1bc95237840152f193aac0249e256dabd58c13 Mon Sep 17 00:00:00 2001 From: Kye Gomez <98760976+kyegomez@users.noreply.github.com> Date: Thu, 1 May 2025 17:05:31 -0700 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index b82bb447..5a68c584 100644 --- a/README.md +++ b/README.md @@ -112,14 +112,6 @@ | 🎯 Use Case Support | • Task-Specific Agents
• Custom Workflows
• Industry Solutions
• Extensible Framework | • Quick deployment
• Flexible solutions
• Industry readiness
• Easy customization | ----- - -## Requirements -- `python3.10` or above! -- `$ pip install -U swarms` And, don't forget to install swarms! -- `.env` file with API keys from your providers like `OPENAI_API_KEY`, `ANTHROPIC_API_KEY` -- Set an `.env` Variable with your desired workspace dir: `WORKSPACE_DIR="agent_workspace"` or do it in your terminal with `export WORKSPACE_DIR="agent_workspace"` - ## Guides and Walkthroughs Refer to our documentation for production grade implementation details. @@ -177,16 +169,16 @@ $ pip install -e . --- -# Usage Examples 🤖 -Here are some example scripts to get you started. For more comprehensive documentation, visit our [docs](https://docs.swarms.world/en/latest/). - -| Example Name | Description | Type of Examples | Link | -| --- | --- | --- | --- | -| Swarms Examples | A collection of simple examples to demonstrate Swarms capabilities. | Basic Usage | [https://github.com/The-Swarm-Corporation/swarms-examples?tab=readme-ov-file](https://github.com/The-Swarm-Corporation/swarms-examples?tab=readme-ov-file) | -| Cookbook | A comprehensive guide with recipes for various use cases and scenarios. | Advanced Usage | [https://github.com/The-Swarm-Corporation/Cookbook](https://github.com/The-Swarm-Corporation/Cookbook) | - +## Environment Configuration +``` +OPENAI_API_KEY="" +WORKSPACE_DIR="agent_workspace" +ANTHROPIC_API_KEY="" +GROQ_API_KEY="" +``` +- [Learn more about the environment configuration here](https://docs.swarms.world/en/latest/swarms/install/env/) ---