Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
  • Loading branch information
Tomas2D committed Oct 14, 2024
1 parent 808dd22 commit 0049ee5
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 0049ee5

Please sign in to comment.