Skip to content

Commit 5ae18ff

Browse files
committed
fix(readme): update readme with latest instructions
1 parent b3204b8 commit 5ae18ff

File tree

1 file changed

+55
-16
lines changed

1 file changed

+55
-16
lines changed

README.md

Lines changed: 55 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
11
# Flare AI DeFAI
22

3-
A modular SDK for confidential AI x DeFi workloads, running on Trusted Execution Environments (TEE) with support for AMD SEV and Intel TDX architectures.
3+
Flare AI SDK template for AI x DeFi (DeFAI).
4+
5+
### 🚀 Key Features
6+
7+
- **Secure AI Execution** – Runs within a Trusted Execution Environment (TEE) with remote attestation support.
8+
- **Built-in Chat UI** – Interact with AI securely, served directly from TEE.
9+
- **Flare Blockchain Integration** – Native support for token transactions and operations.
10+
- **Gemini AI Model Support** – Seamlessly integrates with Google's Gemini AI.
411

512
<img width="500" alt="Artemis" src="https://github.com/user-attachments/assets/921fbfe2-9d52-496c-9b48-9dfc32a86208" />
613

7-
## Prerequisites
14+
## 📌 Prerequisites
15+
16+
Before starting, ensure you have:
17+
18+
- A **Google Cloud Platform** account with access to `google-hackathon-project`.
19+
- A **Gemini API Key** linked to the same project.
20+
- The **`gcloud` CLI** installed and configured on your system.
821

9-
- Google Cloud Platform account with access to the `google-hackathon-project`
10-
- Gemini API key
11-
- `gcloud` CLI installed and configured
22+
## ⚙️ Environment Setup
1223

13-
## Environment Setup
24+
### Step 1: Configure Environment Variables
1425

15-
1. Add the following environment variables to your shell configuration file (`~/.bashrc` or `~/.zshrc`):
26+
Add the following lines to your shell configuration file (`~/.bashrc` or `~/.zshrc`):
1627

1728
```bash
1829
export TEE_IMAGE_REFERENCE=ghcr.io/flare-foundation/flare-ai-defai:main
@@ -22,23 +33,26 @@ export WEB3_EXPLORER_URL=https://coston2-explorer.flare.network/
2233
export TEAM_NAME=<your-team-name>
2334
```
2435

25-
2. Reload your shell configuration:
36+
### Step 2: Apply Configuration
2637

2738
```bash
28-
source ~/.bashrc # or ~/.zshrc
39+
source ~/.bashrc # or source ~/.zshrc
2940
```
3041

31-
3. Verify the configuration:
42+
### Step 3: Verify Setup
3243

3344
```bash
34-
echo $TEE_IMAGE_REFERENCE # Should output: ghcr.io/flare-foundation/flare-ai-defai:main
45+
echo $TEE_IMAGE_REFERENCE
46+
# Expected output: ghcr.io/flare-foundation/flare-ai-defai:main
3547
```
3648

37-
## Deployment
49+
## 🚀 Deployment
3850

39-
### AMD SEV Deployment (recommended)
51+
You can deploy Flare AI DeFAI on **Confidential Compute Instances** using either **AMD SEV** or **Intel TDX**.
4052

41-
Deploy an AMD SEV-enabled instance with the following configuration:
53+
### 🔹 Option 1: AMD SEV (Recommended)
54+
55+
Deploy on **AMD Secure Encrypted Virtualization (SEV)**:
4256

4357
```bash
4458
gcloud compute instances create defai-$TEAM_NAME \
@@ -73,9 +87,9 @@ type=pd-standard \
7387
--confidential-compute-type=SEV
7488
```
7589

76-
### Intel TDX Deployment
90+
### Option 2: Intel TDX
7791

78-
For Intel TDX machines, use this alternative configuration:
92+
Deploy on **Intel Trust Domain Extensions (TDX)**:
7993

8094
```bash
8195
gcloud compute instances create defai-$TEAM_NAME \
@@ -106,3 +120,28 @@ type=pd-balanced \
106120
--shielded-integrity-monitoring \
107121
--confidential-compute-type=TDX
108122
```
123+
124+
## 🔜 Next Steps
125+
126+
Once your instance is running, access the Chat UI via the instance's **public IP address**.
127+
128+
### Example Interactions
129+
130+
💬 **"Create an account for me"**
131+
💬 **"Show me your remote attestation"**
132+
💬 **"Transfer 10 C2FLR to 0x000000000000000000000000000000000000dEaD"**
133+
134+
Enjoy secure AI-powered DeFi with **Flare AI DeFAI**! 🚀
135+
136+
### 🔧 Troubleshooting
137+
138+
If you encounter issues:
139+
140+
1. **Check logs**
141+
142+
```bash
143+
gcloud compute instances get-serial-port-output defai-$TEAM_NAME --project=google-hackathon-project
144+
```
145+
146+
2. **Verify API Key** – Ensure `GEMINI_API_KEY` is correctly set.
147+
3. **Check Firewall** – Ensure your instance has public access.

0 commit comments

Comments
 (0)