Skip to content

Commit 107f139

Browse files
chore: update README.md
1 parent 7a90582 commit 107f139

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

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

5-
<p align="center">
6-
<h1 align="center">Volcengine Agent Development Kit</h1>
7-
</p>
5+
# Volcengine Agent Development Kit
6+
7+
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
8+
[![Deepwiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/volcengine/veadk-python)
89

910
An open-source kit for agent development, integrated the powerful capabilities of Volcengine.
1011

@@ -56,13 +57,10 @@ print(res)
5657

5758
## Command line tools
5859

59-
### Fast deployment
60+
VeADK provides several useful command line tools for faster deployment and optimization, such as:
6061

61-
Deploy your agent service by the following command:
62-
63-
```bash
64-
vego deploy --access-key YOUR_ACCESS_KEY --secret-key YOUR_SECRET_KEY --name YOUR_SERVICE_NAME --path YOUR_PROJECT_PATH
65-
```
62+
- `veadk deploy`: deploy your project to Volcengine VeFaaS platform
63+
- `veadk prompt`: otpimize the system prompt of your agent by PromptPilot
6664

6765
## Contribution
6866

@@ -73,6 +71,12 @@ pip install pre-commit
7371
pre-commit install
7472
```
7573

74+
Before commit or push your changes, please make sure the unittests are passed ,otherwise your PR will be rejected by CI/CD workflow. Running the unittests by:
75+
76+
```bash
77+
pytest -n 16
78+
```
79+
7680
## License
7781

7882
This project is licensed under the [Apache 2.0 License](./LICENSE).

0 commit comments

Comments
 (0)