Skip to content

Commit c7b2f6b

Browse files
authored
Update README formatting and section headers
Signed-off-by: Andrew Mikhail <andrewmikhail@ymail.com>
1 parent 8c91fab commit c7b2f6b

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

โ€ŽREADME.mdโ€Ž

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
[TOC]
2-
# ๐Ÿง  Agents-SDK - A High Performance C++ Framework for AI Agents
2+
# Agents-SDK - A High Performance C++ Framework for AI Agents
33

44
![Linux](https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black)
55
![macOS](https://img.shields.io/badge/macOS-000000?logo=apple&logoColor=F0F0F0)
66
![Windows](https://custom-icon-badges.demolab.com/badge/Windows-0078D6?logo=windows11&logoColor=white)
77

88
**Agents-SDK** is a **portable, high-performance C++ framework** for building **on-device, agentic AI systems** โ€” think **LangChain for the edge**. This SDK is purpose-built for developers who want to create **local-first AI agents** that can reason, plan, and act without relying on the cloud.
99

10-
## ๐Ÿš€ Features
10+
## Features
1111

12-
- โš™๏ธ **Modular Architecture** โ€” Compose agents from interchangeable components.
13-
- ๐Ÿงฉ **Multi-Provider Support** โ€” Connect to multiple LLM providers seamlessly:
12+
- **Modular Architecture** โ€” Compose agents from interchangeable components.
13+
- **Multi-Provider Support** โ€” Connect to multiple LLM providers seamlessly:
1414
- **OpenAI** (GPT-5, GPT-4o, GPT-4)
1515
- **Anthropic** (Claude 3 family models: Opus, Sonnet, Haiku)
1616
- **Google** (Gemini family models: Pro, Flash)
1717
- **Ollama/llama-cpp** (local models like Llama, Mistral, etc.)
18-
- โšก **Optimized for Speed and Memory** โ€” Built in C++ with focus on performance.
19-
- ๐Ÿ” **Built-In Workflow Patterns**
18+
- **Optimized for Speed and Memory** โ€” Built in C++ with focus on performance.
19+
- **Built-In Workflow Patterns**
2020
- Prompt Chaining
2121
- Routing
2222
- Parallelization
2323
- Orchestrator-Workers
2424
- Evaluator-Optimizer
25-
- ๐Ÿค– **Autonomous Agents** โ€” Supports modern reasoning strategies:
25+
- **Autonomous Agents** โ€” Supports modern reasoning strategies:
2626
- ReAct (Reason + Act)
2727
- CoT (Chain-of-Thought) [In Development]
2828
- Plan and Execute
2929
- Zero-Shot [In Development]
3030
- Reflexion [In Development]
31-
- ๐Ÿง  **Extensible Tooling System** โ€” Plug in your own tools or use built-in ones (Web Search, Wikipedia, Python Executor, etc).
31+
- **Extensible Tooling System** โ€” Plug in your own tools or use built-in ones (Web Search, Wikipedia, Python Executor, etc).
3232

33-
## โš™๏ธ Requirements
33+
## Requirements
3434

3535
- C++20 compatible compiler (GCC 14+, Clang 17+, MSVC 2022+)
3636
- Bazel 8.3.1+
@@ -40,7 +40,7 @@
4040
- nlohmann/json
4141
- spdlog
4242

43-
## ๐Ÿงญ Quick Start
43+
## Quick Start
4444

4545
### Installation
4646

@@ -219,7 +219,7 @@ You can modify examples/simple_agent.cpp to explore different configurations:
219219
agent.setPlanningStrategy(AutonomousAgent::PlanningStrategy::COT);
220220
```
221221

222-
## ๐Ÿงช Included Examples
222+
## Included Examples
223223

224224
The repository includes several examples demonstrating different workflow patterns:
225225

@@ -240,7 +240,7 @@ Run examples available:
240240
bazel run examples:<simple_agent> -- your_api_key_here
241241
```
242242

243-
## ๐Ÿ“‚ Project Structure
243+
## Project Structure
244244

245245
- `lib/`: Public library for SDK
246246
- `include/agents-cpp/`: Public headers
@@ -257,7 +257,7 @@ bazel run examples:<simple_agent> -- your_api_key_here
257257
- `llms/`: LLM provider implementations
258258
- `bin/examples/`: Example applications
259259

260-
## ๐Ÿ› ๏ธ Extending the SDK
260+
## Extending the SDK
261261

262262
### Adding Custom Tools
263263

@@ -299,7 +299,7 @@ public:
299299
};
300300
```
301301

302-
## ๐Ÿš€ Running in Production?
302+
## Running in Production?
303303

304304
Don't let infrastructure slow you down. Our Pro version helps accelerate your roadmap with:
305305

@@ -309,16 +309,16 @@ Don't let infrastructure slow you down. Our Pro version helps accelerate your ro
309309

310310
๐Ÿ‘‰ **[Start a free Pro trial](https://runedge.ai/pricing)**
311311

312-
## ๐Ÿ†˜ Support
312+
## Support
313313

314314
- Email: support@runedge.ai
315315
- Discord: https://discord.gg/D5unWmt8
316316

317-
## ๐Ÿ“š Acknowledgements
317+
## Acknowledgements
318318

319319
This implementation is inspired by Anthropic's article ["Building effective agents"](https://www.anthropic.com/research/building-effective-agents) and re-engineered in C++ for real-time, low overhead usage on edge devices.
320320

321-
## โš–๏ธ License
321+
## License
322322

323323
This project is licensed under an evaluation License - see the [LICENSE](./LICENSE.md) file for details.
324324

0 commit comments

Comments
ย (0)