Skip to content

Commit f9764de

Browse files
kasrazunnaiyyercareer-ustaad
authored andcommitted
Improve README for discoverability: badges, tagline, capabilities overview
Add centered header with npm/license/stars badges and navigation links. Add quick-start snippet and capabilities summary above the fold. Consolidate install methods into one section. Add FROST 2-of-2 explainer and cross-links to website, dashboard, docs, and npm.
1 parent 6b62e09 commit f9764de

1 file changed

Lines changed: 57 additions & 10 deletions

File tree

README.md

Lines changed: 57 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,58 @@
1-
# Botwallet CLI
1+
<div align="center">
22

3-
Command-line interface for AI agents to manage their Botwallet accounts.
3+
# BotWallet CLI
44

5-
## Installation
5+
**Your AI has a brain. Give it a wallet.**
6+
7+
[![npm](https://img.shields.io/npm/v/@botwallet/agent-cli?color=blue&label=npm)](https://www.npmjs.com/package/@botwallet/agent-cli)
8+
[![License](https://img.shields.io/badge/license-Apache%202.0-green)](LICENSE)
9+
[![GitHub stars](https://img.shields.io/github/stars/botwallet-co/agent-cli?style=social)](https://github.com/botwallet-co/agent-cli)
10+
11+
The CLI that lets AI agents hold, spend, and earn real money (USDC on Solana).
12+
13+
[Website](https://botwallet.co) · [Dashboard](https://app.botwallet.co) · [Docs](https://docs.botwallet.co) · [npm](https://www.npmjs.com/package/@botwallet/agent-cli)
14+
15+
</div>
16+
17+
---
18+
19+
Three commands. Your agent has a wallet with spending limits, human oversight, and FROST threshold signing.
20+
21+
```bash
22+
npm install -g @botwallet/agent-cli
23+
botwallet register --name "My Agent Wallet" --owner you@email.com
24+
botwallet paylink create 25.00 --desc "Research report" # Your agent just created an invoice
25+
```
26+
27+
**What agents can do with BotWallet:**
28+
- **Pay** other agents and merchants — `botwallet pay @recipient 10.00`
29+
- **Earn** money via invoices and paylinks — `botwallet paylink create`
30+
- **Access paid APIs** through x402 — `botwallet x402 fetch <url>`
31+
- **Request funds** from their human owner — `botwallet fund 50.00`
32+
- **Withdraw** USDC to any Solana address — `botwallet withdraw`
33+
34+
Every transaction is FROST 2-of-2 threshold signed (agent + server). The full private key never exists anywhere. Human owners set guard rails — per-transaction limits, daily caps, merchant allowlists — and approve anything outside the rules.
635

7-
### From Release (Recommended)
36+
## Installation
837

938
```bash
39+
# npm (recommended)
40+
npm install -g @botwallet/agent-cli
41+
1042
# Linux/macOS
1143
curl -fsSL https://botwallet.co/install.sh | bash
1244

1345
# Windows (PowerShell)
1446
iwr https://botwallet.co/install.ps1 | iex
15-
```
1647

17-
### From Source
18-
19-
```bash
48+
# From source
2049
go install github.com/botwallet-co/agent-cli@latest
2150
```
2251

2352
## Quick Start
2453

2554
```bash
26-
# Create a new wallet (FROST threshold key generation, saves credentials locally)
55+
# Create a wallet (FROST threshold key generation, saves credentials locally)
2756
botwallet register --name "Orion's Wallet" --owner "your@email.com"
2857

2958
# Create an invoice and send it
@@ -212,6 +241,17 @@ botwallet wallet list
212241
botwallet wallet use my-other-wallet
213242
```
214243

244+
## How It Works
245+
246+
BotWallet uses **FROST (Flexible Round-Optimized Schnorr Threshold) 2-of-2 signatures**. During wallet creation, a Distributed Key Generation ceremony produces two key shares:
247+
248+
- **S1** (agent's share): stored locally at `~/.botwallet/seeds/<wallet>.seed`
249+
- **S2** (server's share): held by BotWallet, never sent to the agent
250+
251+
The full private key never exists anywhere. Every transaction requires both parties to produce partial signatures that combine into a valid Ed25519 signature. Neither the agent nor BotWallet can move funds alone.
252+
253+
All payments settle in **USDC on Solana** — a dollar-pegged stablecoin. `10.00` = $10.00.
254+
215255
## Building from Source
216256

217257
```bash
@@ -220,6 +260,13 @@ make build-all # All platforms
220260
make test # Run tests
221261
```
222262

263+
## Links
264+
265+
- **Website**: [botwallet.co](https://botwallet.co)
266+
- **Human Dashboard**: [app.botwallet.co](https://app.botwallet.co)
267+
- **Documentation**: [docs.botwallet.co](https://docs.botwallet.co)
268+
- **npm**: [@botwallet/agent-cli](https://www.npmjs.com/package/@botwallet/agent-cli)
269+
223270
## License
224271

225-
Apache 2.0 - See [LICENSE](LICENSE) for details.
272+
Apache 2.0 See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)