From 0049ee52974fe11bfa58d00709382a3464c54402 Mon Sep 17 00:00:00 2001 From: Tomas Dvorak Date: Mon, 14 Oct 2024 20:57:54 +0200 Subject: [PATCH] docs: update README Signed-off-by: Tomas Dvorak --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3ad4f74..3c4011c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,19 @@ -# bee-agent-framework-starter +# Bee Agent Framework Starter + +This starter template allows you to easily start working with the [Bee Agent Framework](https://github.com/i-am-bee/bee-agent-framework) in a second. + +## Key Features + +- ✨ Safely execute an arbitrary Python Code via [Bee Code Interpreter](https://github.com/i-am-bee/bee-code-interpreter). +- ✨ Get complete visibility into agents’ decisions using our MLFlow integration thanks to [Bee Observe](https://github.com/i-am-bee/bee-observe). +- ✨ Fully fledged TypeScript project setup with linting and formatting. ## Getting started -1. Clone the repository `git clone git@github.com:i-am-bee/bee-agent-framework-starter`. -2. Install dependencies `npm ci` -3. Create `.env` (from `.env.template`) and fill in missing values (if any). -4. Start the example `npm run start` (it runs the ./src/agent.ts file). +1. Clone the repository `git clone git@github.com:i-am-bee/bee-agent-framework-starter` or create your own repository from this one. +2. Install dependencies `npm ci`. +3. Fill missing values in `.env`. +4. Run the agent `npm run start` (it runs the `./src/agent.ts` file). ## Infrastructure