Skip to content

Commit 27097dc

Browse files
committed
chore: remove example usage and fix typos in README
1 parent 2b67bb1 commit 27097dc

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
<p align="center">
2-
<img src="assets/images/logo.png" alt="DeepEval Logo" width="80%">
2+
<img src="assets/images/logo.png" alt="Volcengine Agent Development Kit Logo" width="80%">
33
</p>
44

55
<p align="center">
66
<h1 align="center">Volcengine Agent Development Kit</h1>
77
</p>
88

9-
109
An open-source kit for agent development, integrated the powerful capabilities of Volcengine.
1110

1211
## Installation
@@ -35,29 +34,26 @@ uv sync
3534
uv pip install -e .
3635
```
3736

38-
Enjoy VeADK:
37+
## Configuration
38+
39+
We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically.
40+
41+
You can refer to the [example config file](config.yaml.example) for more details.
42+
43+
## Have a try
44+
45+
Enjoy a minimal agent from VeADK:
3946

4047
```python
4148
from veadk import Agent
4249
import asyncio
4350

4451
agent = Agent()
52+
4553
res = asyncio.run(agent.run("hello!"))
4654
print(res)
4755
```
4856

49-
## Configuration
50-
51-
We recommand you to create a `config.yaml` file in the root directory of your project. You can refer to the [example config file](config.yaml.example) for more details.
52-
53-
## Run examples
54-
55-
With `uv`:
56-
57-
```bash
58-
uv run examples/features/...
59-
```
60-
6157
## Command line tools
6258

6359
### Fast deployment

0 commit comments

Comments
 (0)