Skip to content

Commit 6a29e42

Browse files
tfiusclaude
andcommitted
docs: Clarify required vs optional secrets in README
Add table showing which secrets are required: - SX_KEY: Required for write commands - SX_RPC: Optional (has default) - SX_API: Optional (has default) Separate quick setup from optional configuration. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent eaade1b commit 6a29e42

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,21 @@ Interact with the Skill Exchange protocol API and DataEscrow smart contract.
3636

3737
Store your credentials securely in the OS keychain:
3838

39+
| Secret | Required | Description |
40+
|--------|----------|-------------|
41+
| `SX_KEY` | **Yes** (for write commands) | Ethereum private key for signing transactions |
42+
| `SX_RPC` | No | RPC URL (defaults to https://mainnet.base.org) |
43+
| `SX_API` | No | API URL (defaults to https://agents.datafund.io) |
44+
45+
**Quick setup for write commands:**
46+
```bash
47+
ade set SX_KEY # Required - Enter your private key when prompted
48+
```
49+
50+
**Optional configuration:**
3951
```bash
40-
ade set SX_KEY # Private key for signing transactions
41-
ade set SX_RPC # RPC URL (optional, defaults to https://mainnet.base.org)
42-
ade set SX_API # API URL (optional, defaults to https://agents.datafund.io)
52+
ade set SX_RPC # Custom RPC endpoint (only if default doesn't work)
53+
ade set SX_API # Custom API endpoint (for development)
4354
```
4455

4556
#### SX_KEY - Your Private Key

0 commit comments

Comments
 (0)