Skip to content

Commit 9a79d1d

Browse files
committed
fix(readme): update readme
1 parent 51b6819 commit 9a79d1d

File tree

1 file changed

+19
-29
lines changed

1 file changed

+19
-29
lines changed

README.md

Lines changed: 19 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Flare AI Kit
22

3-
SDK for building **verifiable AI Agents** on Flare using Confidential Space.
3+
SDK for building **verifiable AI Agents** on Flare using Confidential Space Trusted Execution Environments (TEEs).
44

55
> [!WARNING]
66
>
7-
> Flare AI Kit is currently under active development (pre-release/alpha stage).
7+
> Flare AI Kit is currently under active development (alpha stage).
88
>
99
> Interfaces, APIs, and functionalities may change frequently and potentially in backward-incompatible ways before a stable release.
1010
> Use with caution.
1111
1212
## ✨ Features
1313

14-
- **Verifiable Execution**: Run logic in hardware‑isolated TEEs - [GCP Confidential Space TDX](https://cloud.google.com/confidential-computing/confidential-space/docs/confidential-space-overview).
15-
- **Consensus Engine**: Multi‑agent [Consensus Learning](https://arxiv.org/abs/2402.16157) via [Google Agent2Agent](https://github.com/a2aproject/A2A) protocol.
16-
- **Strictly‑Typed Agents**: Build with [PydanticAI](https://ai.pydantic.dev) to enforce structured outputs across 200+ LLMs.
17-
- **Flare Protocol Integration**: [FTSO](https://dev.flare.network/ftso/overview), [FDC](https://dev.flare.network/fdc/overview), [FAssets](https://dev.flare.network/fassets/overview), plus ecosystem dApps like [Sceptre](http://sceptre.fi) and [SparkDEX](https://sparkdex.ai).
18-
- **Social Intelligence**: Analytics and connectors for X, Telegram, Farcaster.
14+
- **Verifiable execution**: Run logic inside Intel TDX TEEs via [GCP Confidential Space](https://cloud.google.com/confidential-computing/confidential-space/docs/confidential-space-overview).
15+
- **Multi-agent consensus**: Majority/Tournament/[Consensus Learning](https://arxiv.org/abs/2402.16157) via [Google Agent2Agent](https://github.com/a2aproject/A2A) protocol.
16+
- **Agent framework**: Built on [Google ADK](https://google.github.io/adk-docs/) with tool-calling, orchestration and evaluation.
17+
- **Flare integration**: [FTSO](https://dev.flare.network/ftso/overview), [FDC](https://dev.flare.network/fdc/overview), [FAssets](https://dev.flare.network/fassets/overview) + ecosystem dApps ([Sceptre](https://sceptre.fi), [SparkDEX](https://sparkdex.ai), ...).
18+
- **Social connectors**: X, Telegram, Farcaster.
1919

2020
## 🏗️ Architecture
2121

@@ -80,22 +80,17 @@ flowchart TD
8080

8181
- [uv](https://github.com/astral-sh/uv) with Python >= 3.12
8282
- [Docker](https://www.docker.com).
83+
- (For deployment) Authenticated [gcloud CLI](https://cloud.google.com/sdk/docs/install).
8384

84-
1. **Clone the repo:**
85+
1. **Clone & configure:**
8586

8687
```bash
8788
git clone --recursive https://github.com/flare-foundation/flare-ai-kit.git
8889
cd flare-ai-kit
90+
cp .env.example .env # add API keys and settings
8991
```
9092

91-
2. **Configure your environment:**
92-
93-
```bash
94-
# Copy the template and add your models, API keys etc.
95-
cp .env.example .env
96-
```
97-
98-
3. **Install dependencies:**
93+
2. **Install:**
9994

10095
```bash
10196
uv sync --all-extras
@@ -106,22 +101,15 @@ flowchart TD
106101
Run the following commands to format, lint, type-check, and test your code before committing.
107102

108103
```bash
109-
# Format, lint, and auto-fix
110-
uv run ruff format
111-
uv run ruff check --fix
112-
113-
# Run static type checking
114-
uv run pyright
115-
116-
# Run tests
117-
uv run pytest
104+
# Format, lint, type-check, test
105+
uv run ruff format && uv run ruff check --fix && uv run pyright && uv run pytest
118106
```
119107

120-
## 🚧 Build with Docker
108+
## 🐳 Docker
121109

122110
```bash
123111
docker build -t flare-ai-kit .
124-
docker run -rm --env-file .env flare-ai-kit
112+
docker run --rm --env-file .env flare-ai-kit
125113
```
126114

127115
## ☁️ Deploy to Confidential Space
@@ -134,12 +122,14 @@ docker run -rm --env-file .env flare-ai-kit
134122

135123
```bash
136124
chmod +x gcloud-deploy.sh
137-
./gcloud-deploy.sh # For verbose mode: ./gcloud-deploy.sh -v
125+
./gcloud-deploy.sh # verbose: ./gcloud-deploy.sh -v
138126
```
139127

140128
## 🤝 Contributing
141129

142-
Contributions are highly encouraged! Please review the [CONTRIBUTING.md](CONTRIBUTING.md) guide for details on code style (Conventional Commits, Strict Typing), testing, and the PR process.
130+
See [CONTRIBUTING.md](CONTRIBUTING.md).
131+
We use Conventional Commits, Ruff/Pyright gates, and pytest.
132+
Please include tests and update docs for any user-visible changes.
143133

144134
## 📜 License
145135

0 commit comments

Comments
 (0)