Skip to content

Commit 928ef0a

Browse files
docs: add Quick Start section to README for better onboarding
- Added concise 3-step Quick Start guide - Reorganized existing example under 'Example Usage' section - Improves new user experience with clear getting started steps
1 parent 7bd1f04 commit 928ef0a

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,25 @@
2424

2525
The Codegen SDK provides a programmatic interface to code agents provided by [Codegen](https://codegen.com).
2626

27+
## Quick Start
28+
29+
1. **Install the SDK**:
30+
```bash
31+
pip install codegen
32+
```
33+
34+
2. **Get your API credentials** at [codegen.com/developer](https://codegen.com/developer)
35+
36+
3. **Run your first agent**:
37+
```python
38+
from codegen.agents.agent import Agent
39+
40+
agent = Agent(org_id="YOUR_ORG_ID", token="YOUR_API_TOKEN")
41+
task = agent.run(prompt="Add a hello world function to my codebase")
42+
```
43+
44+
## Example Usage
45+
2746
```python
2847
from codegen.agents.agent import Agent
2948

0 commit comments

Comments
 (0)