Skip to content

Commit 3814635

Browse files
committed
docs(readme): add logo, title, badges, links to other repos (strands-agents#13)
1 parent 4350047 commit 3814635

File tree

1 file changed

+55
-16
lines changed

1 file changed

+55
-16
lines changed

README.md

Lines changed: 55 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,36 @@
1-
# Strands Agent Builder
1+
<div align="center">
2+
<div>
3+
<a href="https://strandsagents.com">
4+
<img src="https://strandsagents.com/latest/assets/logo.svg" alt="Strands Agents" width="55px" height="105px">
5+
</a>
6+
</div>
7+
8+
<h1>
9+
Strands Agent Builder
10+
</h1>
11+
12+
<h2>
13+
A model-driven approach to building AI agents in just a few lines of code.
14+
</h2>
15+
16+
<div align="center">
17+
<a href="https://github.com/strands-agents/agent-builder/graphs/commit-activity"><img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/strands-agents/agent-builder"/></a>
18+
<a href="https://github.com/strands-agents/agent-builder/issues"><img alt="GitHub open issues" src="https://img.shields.io/github/issues/strands-agents/agent-builder"/></a>
19+
<a href="https://github.com/strands-agents/agent-builder/pulls"><img alt="GitHub open pull requests" src="https://img.shields.io/github/issues-pr/strands-agents/agent-builder"/></a>
20+
<a href="https://github.com/strands-agents/agent-builder/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/strands-agents/agent-builder"/></a>
21+
<a href="https://pypi.org/project/strands-agents-builder/"><img alt="PyPI version" src="https://img.shields.io/pypi/v/strands-agents-builder"/></a>
22+
<a href="https://python.org"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/strands-agents-builder"/></a>
23+
</div>
24+
25+
<p>
26+
<a href="https://strandsagents.com/">Documentation</a>
27+
◆ <a href="https://github.com/strands-agents/samples">Samples</a>
28+
◆ <a href="https://github.com/strands-agents/sdk-python">Python SDK</a>
29+
◆ <a href="https://github.com/strands-agents/tools">Tools</a>
30+
◆ <a href="https://github.com/strands-agents/agent-builder">Agent Builder</a>
31+
◆ <a href="https://github.com/strands-agents/mcp-server">MCP Server</a>
32+
</p>
33+
</div>
234

335
An interactive Strands agent toolkit designed to help you build, test, and extend your own custom AI agents and tools. With the Strands Agent Builder, you can create specialized agents, develop custom tools, and compose complex AI workflows—all from your terminal.
436

@@ -176,22 +208,29 @@ export STRANDS_SYSTEM_PROMPT="You are a Python expert."
176208
echo "You are a security expert." > .prompt
177209
```
178210

179-
## Contributing
211+
## Exit
180212

181-
```bash
182-
git clone https://github.com/strands-agents/agent-builder.git ~/.agent-builder
183-
cd ~/.agent-builder
184-
python3 -m venv venv && source venv/bin/activate
185-
pip3 install -e .
186-
pip3 install -e ".[test]"
187-
188-
# Run tests
189-
hatch run test # Run all tests with verbose coverage output
190-
hatch run test -k test_pattern # Run specific tests matching a pattern
191-
```
213+
Type `exit`, `quit`, or press `Ctrl+C`/`Ctrl+D`
192214

193-
Testing is managed through hatch scripting in pyproject.toml.
215+
## Contributing ❤️
194216

195-
## Exit
217+
We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) for details on:
218+
- Reporting bugs & features
219+
- Development setup
220+
- Contributing via Pull Requests
221+
- Code of Conduct
222+
- Reporting of security issues
196223

197-
Type `exit`, `quit`, or press `Ctrl+C`/`Ctrl+D`
224+
## License
225+
226+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
227+
228+
## Security
229+
230+
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
231+
232+
## ⚠️ Preview Status
233+
234+
Strands Agents is currently in public preview. During this period:
235+
- APIs may change as we refine the SDK
236+
- We welcome feedback and contributions

0 commit comments

Comments
 (0)