@btcemail/cli 0.3.0 → 0.5.0

package/README.md

@@ -2,10 +2,40 @@
 
 Command-line interface for btc.email - spam-free email powered by Bitcoin Lightning.
 
-Current version: 0.3.0 (December 28, 2025)
+Current version: 0.4.0 (December 28, 2025)
 
 ## Installation
 
+### Option 1: Pre-built Binary (Recommended)
+
+Download the latest binary for your platform from [GitHub Releases](https://github.com/8bittts/btcemail/releases).
+
+macOS (Apple Silicon):
+```bash
+curl -L https://github.com/8bittts/btcemail/releases/latest/download/btcemail-darwin-arm64 -o btcemail
+chmod +x btcemail
+sudo mv btcemail /usr/local/bin/
+```
+
+macOS (Intel):
+```bash
+curl -L https://github.com/8bittts/btcemail/releases/latest/download/btcemail-darwin-x64 -o btcemail
+chmod +x btcemail
+sudo mv btcemail /usr/local/bin/
+```
+
+Linux (x64):
+```bash
+curl -L https://github.com/8bittts/btcemail/releases/latest/download/btcemail-linux-x64 -o btcemail
+chmod +x btcemail
+sudo mv btcemail /usr/local/bin/
+```
+
+Windows:
+Download `btcemail-windows-x64.exe` from the releases page and add to your PATH.
+
+### Option 2: npm/bun
+
 ```bash
 npm install -g @btcemail/cli
 ```
@@ -105,6 +135,82 @@ btcemail credits purchase         # Shows options
 btcemail credits purchase --option 1 --wait
 ```
 
+### Settings
+
+```bash
+# Show current settings
+btcemail settings                 # or: btcemail settings show
+
+# Set email price in sats
+btcemail settings pricing 100
+
+# Toggle payment requirement
+btcemail settings require-payment on
+btcemail settings require-payment off
+
+# Toggle auto-whitelist after payment
+btcemail settings auto-whitelist on
+btcemail settings auto-whitelist off
+
+# Set custom auto-reply message
+btcemail settings auto-reply "Thanks for your email!"
+btcemail settings auto-reply --clear   # Reset to default
+```
+
+### Whitelist
+
+Manage senders who can email you for free.
+
+```bash
+# List whitelist entries
+btcemail whitelist                # or: btcemail wl
+
+# Add email or domain
+btcemail whitelist add friend@example.com
+btcemail whitelist add @company.com --note "Work contacts"
+
+# Remove entry by ID
+btcemail whitelist remove <entry-id>
+```
+
+### Blocklist
+
+Manage blocked senders (silently rejected).
+
+```bash
+# List blocklist entries
+btcemail blocklist                # or: btcemail bl
+
+# Add email or domain
+btcemail blocklist add spammer@example.com
+btcemail blocklist add @spam.com --reason "Known spam domain"
+
+# Remove entry by ID
+btcemail blocklist remove <entry-id>
+```
+
+### Network
+
+Switch between testnet and mainnet Lightning networks.
+
+```bash
+# Show current network mode
+btcemail network
+
+# Switch to testnet (fake Bitcoin)
+btcemail network testnet
+
+# Switch to mainnet (real Bitcoin)
+btcemail network mainnet
+```
+
+### Stats
+
+```bash
+# Show dashboard statistics
+btcemail stats
+```
+
 ## Options Reference
 
 ### list
@@ -231,7 +337,8 @@ bun run typecheck
 
 ## Requirements
 
-- Node.js 18 or later
+- Pre-built binary: No runtime required (standalone executable)
+- npm/bun install: Node.js 18 or later
 - An active btc.email account
 
 ## License