vacuum-sol 1.0.0 → 1.0.1

package/README.md

@@ -4,28 +4,106 @@
 
 Vacuum is an automated rent-reclaim bot that monitors **operator-owned** token accounts and safely reclaims rent SOL when accounts are closed or have zero balance. Perfect for custodial services, development environments, and anyone managing their own Solana token accounts at scale.
 
-![NPM Version](https://img.shields.io/badge/version-1.0.0-blue)
+[![NPM Version](https://img.shields.io/npm/v/vacuum-sol)](https://www.npmjs.com/package/vacuum-sol)
 ![License](https://img.shields.io/badge/license-MIT-green)
 ![Solana](https://img.shields.io/badge/solana-compatible-purple)
 
 ---
 
-## 🚀 Quick Start
+## � Installation
+
+### Install via npm (Recommended)
 
 ```bash
-# Clone and install
-git clone https://github.com/your-username/vacuum-sol
-cd vacuum-sol
+# Install globally
+npm install -g vacuum-sol
+
+# Verify installation
+vacuum --version
+vacuum --help
+```
+
+### Or clone from source
+
+```bash
+git clone https://github.com/Don-Vicks/vaccum.git
+cd vaccum
 npm install && npm run build
+npm link  # Make 'vacuum' command available globally
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1. Initial Setup
+
+```bash
+# Create a configuration directory
+mkdir -p ~/.vacuum
+
+# Set up your environment variables
+export SOLANA_RPC_URL=https://api.devnet.solana.com
+export TREASURY_ADDRESS=<your-wallet-address>
+export OPERATOR_KEYPAIR_PATH=~/.vacuum/operator-keypair.json
 
-# Configure
-cp .env.example .env
-# Edit .env with your TREASURY_ADDRESS
+# Or create a .env file in your project directory
+cat > .env << EOF
+# Solana RPC Configuration
+SOLANA_RPC_URL=https://api.devnet.solana.com
 
-# Run
-npm start -- scan          # Find accounts
-npm start -- check --all   # Find reclaimable
-npm start -- reclaim --dry-run  # Preview reclaim
+# Operator treasury address - rent will be reclaimed here
+TREASURY_ADDRESS=<your-wallet-address>
+
+# Path to operator keypair file (must have authority to close accounts)
+OPERATOR_KEYPAIR_PATH=~/.vacuum/operator-keypair.json
+
+# Kora Node Configuration (optional - for monitoring sponsored accounts)
+KORA_NODE_URL=
+
+# Safety Configuration
+DRY_RUN=true
+COOLDOWN_HOURS=24
+MIN_INACTIVE_DAYS=7
+
+# Telegram Bot (optional)
+# Create bot via @BotFather on Telegram
+TELEGRAM_BOT_TOKEN=
+# Your personal chat ID (get via @userinfobot)
+TELEGRAM_CHAT_ID=
+
+# Database path
+DB_PATH=./data/accounts.db
+
+# Dashboard port (optional)
+DASHBOARD_PORT=3333
+EOF
+```
+
+### 2. Run Your First Scan
+
+```bash
+# Scan for accounts
+vacuum scan
+
+# Find reclaimable accounts
+vacuum check --all
+
+# Preview reclaim (safe, dry-run mode)
+vacuum reclaim --dry-run
+
+# Actually reclaim rent
+vacuum reclaim --yes
+```
+
+### 3. View Reports
+
+```bash
+# Show summary
+vacuum report
+
+# Show history
+vacuum report --history
 ```
 
 ---
@@ -156,6 +234,9 @@ SOLANA_RPC_URL=https://api.devnet.solana.com
 TREASURY_ADDRESS=<your-wallet-address>
 OPERATOR_KEYPAIR_PATH=./operator-keypair.json
 
+# Optional - Kora Node
+KORA_NODE_URL=
+
 # Optional
 DRY_RUN=true
 COOLDOWN_HOURS=24
@@ -165,6 +246,7 @@ TELEGRAM_CHAT_ID=
 
 # Database
 DB_PATH=./data/accounts.db
+DASHBOARD_PORT=3333
 ```
 
 ---
@@ -356,7 +438,7 @@ MIT License - see [LICENSE](LICENSE)
 <div align="center">
   <strong>Built with ❤️ for the Solana ecosystem</strong>
   <br><br>
-  <a href="https://github.com/your-username/vacuum-sol">GitHub</a> •
-  <a href="https://t.me/vacuumsol">Telegram</a> •
-  <a href="https://your-landing-page.com">Website</a>
+  <a href="https://github.com/Don-Vicks/vaccum">GitHub</a> •
+  <a href="https://www.npmjs.com/package/vacuum-sol">NPM</a> •
+  <a href="http://vaccum-bot.vercel.app">Website</a>
 </div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vacuum-sol",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Vacuum - Suck up forgotten rent from Solana accounts",
   "type": "module",
   "main": "dist/index.js",