Skip to content

Commit 944d759

Browse files
authored
Added new guide to project README and minor link fixes. (#197)
1 parent 0bd1475 commit 944d759

File tree

2 files changed

+22
-15
lines changed

2 files changed

+22
-15
lines changed

README.md

+20-13
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# 🪡 orra (✨Alpha✨)
22

3-
Move beyond simple Crews and Agents. Use Orra to build production-ready multi-agent applications that handle complex real-world interactions.
3+
Move beyond simple Crews and Agents. Use orra to build production-ready multi-agent applications that handle complex real-world interactions.
44

55
![](images/orra-diagram.png)
66

7-
Orra coordinates tasks across your existing stack, agents and any tools run as services using intelligent reasoning — across any language, agent framework or deployment platform.
7+
orra coordinates tasks across your existing stack, agents and any tools run as services using intelligent reasoning — across any language, agent framework or deployment platform.
88

99
* 🧠 Smart pre-evaluated execution plans
1010
* 🎯 Domain grounded
@@ -27,6 +27,9 @@ Orra coordinates tasks across your existing stack, agents and any tools run as s
2727

2828
- [Installation](#installation)
2929
- [How The Plan Engine Works](#how-the-plan-engine-works)
30+
- [Guides](#guides)
31+
- [Explore Examples](#explore-examples)
32+
- [Docs](#docs)
3033
- [Self Hosting](#self-hosting)
3134
- [Join Our Alpha Testing Community](#join-our-alpha-testing-community)
3235
- [License](#license)
@@ -76,7 +79,7 @@ Update the .env file with:
7679
PLAN_CACHE_OPENAI_API_KEY=xxxx
7780
```
7881

79-
### 1. Install Orra CLI
82+
### 1. Install orra CLI
8083

8184
Download the latest CLI binary for your platform from our [releases page](https://github.com/orra-dev/orra/releases):
8285

@@ -95,7 +98,7 @@ orra version
9598

9699
[Full CLI documentation](docs/cli.md)
97100

98-
### 2. Get Orra Plan Engine Running
101+
### 2. Get orra Plan Engine Running
99102

100103
Clone the repository and start the Plan Engine:
101104

@@ -115,7 +118,7 @@ The Plan Engine powers your multi-agent applications through intelligent plannin
115118

116119
#### 1. Base Planning
117120

118-
Your agents stay clean and simple (wrapped in the Orra SDK):
121+
Your agents stay clean and simple (wrapped in the orra SDK):
119122

120123
**Python**
121124
```python
@@ -220,33 +223,37 @@ The Plan Engine ensures:
220223
* Real-time status updates
221224
* Webhook result delivery
222225

223-
### Explore Examples
226+
## Guides
227+
228+
- [From Fragile to Production-Ready Multi-Agent App](https://github.com/orra-dev/agent-fragile-to-prod-guide)
229+
230+
## Explore Examples
224231

225232
- 🛒 [E-commerce AI Assistant (JavaScript)](examples/ecommerce-agent-app) - E-commerce customer service with a delivery specialized agent
226-
- 👻 [Ghostwriters (Python)](examples/crewai-ghostwriters) - Content generation example showcasing how to use Orra with [CrewAI](https://www.crewai.com) 🆕🎉
233+
- 👻 [Ghostwriters (Python)](examples/crewai-ghostwriters) - Content generation example showcasing how to use orra with [CrewAI](https://www.crewai.com) 🆕🎉
227234
- 📣 [Echo Tools as Service (JavaScript)](examples/echo-js) - Simple example showing core concepts using JS
228235
- 📣 [Echo Tools as Service (Python)](examples/echo-python) - Simple example showing core concepts using Python
229236

230-
### Docs and Guides
237+
## Docs
231238

232-
- [Rapid Multi-Agent App Development with Orra](docs/rapid-agent-app-devlopment.md)
233-
- [What is an Agent in Orra?](docs/what-is-agent.md)
234-
- [Orchestrating Actions with Orra](docs/actions.md)
239+
- [Rapid Multi-Agent App Development with orra](docs/rapid-agent-app-devlopment.md)
240+
- [What is an Agent in orra?](docs/what-is-agent.md)
241+
- [Orchestrating Actions with orra](docs/actions.md)
235242
- [Domain Grounding Execution](docs/grounding.md)
236243
- [Execution Plan Caching](docs/plan-caching.md)
237244
- [Core Topics & Internals](docs/core.md)
238245

239246
## Self Hosting
240247

241248
1. **Storage**: We use BadgerDB to persist all state
242-
2. **Deployment**: Single-instance only, designed for development and self-hosted deployments
249+
2. **Deployment**: Single-instance only, using containers designed for development and self-hosted deployments
243250

244251
## Join Our Alpha Testing Community
245252

246253
**We're looking for developers who:**
247254

248255
- Are building multi-agent applications
249-
- Want to help shape Orra's development
256+
- Want to help shape orra's development
250257
- Are comfortable working with Alpha software
251258
- Can provide feedback on real-world use cases
252259

docs/cli.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The Orra CLI helps you manage your multi-agent apps in development and productio
44

55
## Installation
66

7-
Download the latest binary for your platform from our [releases page](https://github.com/orra-dev/orra/releases/tag/v0.2.2):
7+
Download the latest binary for your platform from our [releases page](https://github.com/orra-dev/orra/releases):
88

99
```bash
1010
# macOS/Linux: Move to your PATH
@@ -13,7 +13,7 @@ chmod +x /usr/local/bin/orra
1313

1414
# Verify installation
1515
orra version
16-
# Client Version: v0.2.2
16+
# Client Version: v0.2.3
1717
```
1818

1919
## CLI Commands Reference

0 commit comments

Comments
 (0)