more concise instructions

Author: vim-zz

Cargo.lock

@@ -1,224 +1,144 @@
 # Something in the Background
 
-A lightweight native macOS utility for running scripts and commands in the background - powered by Rust.
-
-`something_bg` is a tiny menu/tray app (macOS, Linux, Windows) designed to take any script or command you already use and run it quietly in the background. No terminals to keep open, no remembering where scripts live, no complicated setup.
-
-If you’ve ever left a Terminal window open _“just to keep a command running”_, this app is for you.
+A native menu bar utility for managing background processes, SSH tunnels, and scheduled tasks.
 
 <img src="something_bg_menu.png" alt="Menu Bar Screenshot" width="600">
 
-## Repository layout
-
-- `core/` — platform-agnostic logic (config, scheduler, tunnel management).
-- `app-macos/` — macOS shell (tray UI, oslog, wake detection) that links to `core`.
-- `app-linux/` — Linux tray shell that links to `core`.
-- `app-windows/` — Windows tray shell that links to `core`.
-
 ## Features
 
-- Tiny native macOS app with a Rust core (less than 1MB)
-- Run any script or CLI task without keeping a terminal open
-- Run scripts on a schedule without cron, or launchd
-- Controlled from the menu bar
-- Everything is configured with one simple config file
+- Run SSH tunnels, port forwards, and development servers without keeping terminals open
+- Schedule tasks using cron syntax
+- Toggle services on/off from the menu bar
+- Cross-platform support (macOS, Linux, Windows)
+- Lightweight (<1MB) with simple configuration
 
 ## Installation
 
-### macOS (native bundle)
-
-Prereqs:
-- Rust and Cargo (install via [rustup](https://rustup.rs/))
-- Xcode Command Line Tools
-- cargo-bundle (`cargo install cargo-bundle`)
+### macOS
 
-1. Clone the repository:
+**Step 1: Install Rust** (skip if already installed)
 ```bash
-git clone https://github.com/vim-zz/something_bg.git
-cd something_bg
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+source $HOME/.cargo/env
 ```
 
-2. Build and bundle the macOS application (uses the macOS crate manifest so icons/identifier are applied):
+**Step 2: Install build tools**
 ```bash
-./scripts/bundle-macos.sh
+xcode-select --install
+cargo install cargo-bundle
 ```
 
-3. Install or run
+**Step 3: Build and install**
 ```bash
-# run from build location
-open "target/release/bundle/osx/Something in the Background.app"
-# or install
+git clone https://github.com/vim-zz/something_bg.git
+cd something_bg
+./scripts/bundle-macos.sh
 cp -r "target/release/bundle/osx/Something in the Background.app" /Applications/
 ```
 
-### Linux (tray shell)
+Launch from Applications or run: `open "/Applications/Something in the Background.app"`
 
-Prereqs (Ubuntu/Debian):
-```bash
-sudo apt install libayatana-appindicator3-dev libgtk-3-dev
-```
+### Linux
 
-Run the tray app:
+**Prerequisites** (Ubuntu/Debian):
 ```bash
-cargo run -p something_bg_linux
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+source $HOME/.cargo/env
+sudo apt install libayatana-appindicator3-dev libgtk-3-dev
 ```
 
-You’ll get a status icon in the system tray:
-- Click tunnels to toggle them on/off (checkboxes reflect state)
-- “Run now” under each scheduled task runs it immediately
-- “Open config folder” opens `~/.config/something_bg/`
-- “Quit” cleans up tunnels and stops the scheduler
-
-#### Run cargo check in Docker (no local GTK deps needed)
+**Build and run**:
 ```bash
-./scripts/linux-cargo-check.sh
+git clone https://github.com/vim-zz/something_bg.git
+cd something_bg
+cargo run -p something_bg_linux --release
 ```
-The script builds an Ubuntu-based image with GTK/AppIndicator dev packages and runs `cargo check -p something_bg_linux` inside it. Pass extra cargo args after the script if needed.
 
-### Windows (tray shell, cross-compiling from macOS/Linux)
+### Windows
 
-Prereqs: Docker.
-
-Cross-check/build with the bundled cargo-xwin image:
-```bash
-./scripts/windows-cargo-check.sh
-```
-This builds `something_bg_windows` for `x86_64-pc-windows-msvc` using the Windows SDK bundled in the Docker image. Pass extra cargo args after the script if needed.
-
-To run on Windows natively, build on Windows with a Rust toolchain and the `tray-icon` deps:
+**Build on Windows**:
 ```powershell
+# Install Rust from https://rustup.rs/
+git clone https://github.com/vim-zz/something_bg.git
+cd something_bg
 cargo build -p something_bg_windows --release
+.\target\release\something_bg_windows.exe
 ```
-Then launch the produced `target\release\something_bg_windows.exe`.
 
 ## Configuration
 
-The app loads all menu items from `~/.config/something_bg/config.toml`. On first run, it creates this file with example configurations.
+Configuration is stored in `~/.config/something_bg/config.toml` (created on first run).
 
-### Example Configuration
+### Example
 
 ```toml
-# Custom PATH for command execution
 path = "/bin:/usr/bin:/usr/local/bin:/opt/homebrew/bin"
 
-[tunnels]
-
-# SSH tunnel with port forwarding
-[tunnels.database-prod]
-name = "PROD"
+# SSH tunnel
+[tunnels.database]
+name = "Database (PROD)"
 command = "ssh"
 args = ["-N", "-L", "5432:localhost:5432", "user@server.com"]
 kill_command = "pkill"
 kill_args = ["-f", "user@server.com"]
-group_header = "DATABASE"           # Optional: Section header
-group_icon = "sf:cylinder.fill"     # Optional: SF Symbol icon
-
-[tunnels.database-dev]
-name = "DEV"
-command = "ssh"
-args = ["-N", "-L", "5432:localhost:5432", "dev@server.com"]
-kill_command = "pkill"
-kill_args = ["-f", "dev@server.com"]
-separator_after = true              # Optional: Add separator after this item
+group_header = "DATABASE"
+group_icon = "sf:cylinder.fill"
 
-# Kubernetes port forwarding
+# Port forwarding
 [tunnels.k8s-service]
-name = "Service"
+name = "API Service"
 command = "kubectl"
-args = ["port-forward", "svc/my-service", "8080:8080"]
+args = ["port-forward", "svc/api", "8080:8080"]
 kill_command = "pkill"
-kill_args = ["-f", "svc/my-service"]
+kill_args = ["-f", "svc/api"]
 group_header = "KUBERNETES"
-group_icon = "sf:cloud.fill"
-
-# Development server
-[tunnels.dev-server]
-name = "Dev Server"
-command = "npm"
-args = ["run", "dev"]
-kill_command = "pkill"
-kill_args = ["-f", "npm.*dev"]
-group_header = "DEVELOPMENT"
-group_icon = "sf:hammer.fill"
 separator_after = true
 
-[schedules.daily-backup]
-name = "Daily Backup"
-command = "/usr/local/bin/backup.sh"
-args = []
-cron_schedule = "0 6 * * *"          # Every day at 6:00 AM
-group_header = "SCHEDULED TASKS"
-group_icon = "sf:clock.fill"
-```
-
-### Configuration Fields
-
-**For Tunnels:**
-- `name`: Display name in the menu
-- `command` + `args`: Command to start the service
-- `kill_command` + `kill_args`: Command to stop the service
-
-**For Scheduled Tasks:**
-- `name`: Display name in the menu
-- `command` + `args`: Command to execute
-- `cron_schedule`: Cron expression for scheduling (e.g., "0 6 * * *")
-
-**Optional fields (both types):**
-- `group_header`: Section title (e.g., "DATABASE", "SCHEDULED TASKS")
-- `group_icon`: SF Symbol name for the header (e.g., "sf:cylinder.fill", "sf:clock.fill")
-- `separator_after`: Add a visual separator line after this item
-
-### Scheduled Tasks
-
-Schedule commands to run automatically using cron syntax. Perfect for backups, health checks, or recurring maintenance tasks.
-
-```toml
-[schedules.daily-backup]
+# Scheduled task
+[schedules.backup]
 name = "Daily Backup"
 command = "/usr/local/bin/backup.sh"
 args = []
-cron_schedule = "0 6 * * *"          # Every day at 6:00 AM
-group_header = "SCHEDULED TASKS"
+cron_schedule = "0 6 * * *"
+group_header = "SCHEDULED"
 group_icon = "sf:clock.fill"
-
-[schedules.hourly-health-check]
-name = "API Health Check"
-command = "curl"
-args = ["-f", "https://api.example.com/health"]
-cron_schedule = "0 * * * *"          # Every hour
-
-[schedules.weekly-cleanup]
-name = "Weekly Cleanup"
-command = "/usr/local/bin/cleanup.sh"
-args = ["--deep"]
-cron_schedule = "0 3 * * 0"          # Every Sunday at 3:00 AM
-separator_after = true
 ```
 
-**Cron Schedule Format:** `minute hour day_of_month month day_of_week`
-
-Common examples:
-- `0 * * * *` - Every hour
-- `*/15 * * * *` - Every 15 minutes
-- `0 6 * * *` - Every day at 6:00 AM
-- `0 9 * * 1` - Every Monday at 9:00 AM
-- `0 0 1 * *` - First day of every month at midnight
-
-### SF Symbols
-
-Group icons use SF Symbols (built-in macOS icons). Common symbols:
-- `sf:cylinder.fill` - Database
-- `sf:shippingbox.fill` - Cache/Redis
-- `sf:chart.bar.fill` - Analytics
-- `sf:cloud.fill` - Cloud/Kubernetes
-- `sf:server.rack` - Server
-- `sf:network` - Network
-- `sf:clock.fill` - Scheduled tasks
-- `sf:calendar` - Time-based operations
+### Fields
+
+**Tunnels** (toggleable services):
+- `name` — Display name
+- `command`, `args` — Start command
+- `kill_command`, `kill_args` — Stop command
+- `group_header` _(optional)_ — Section title
+- `group_icon` _(optional)_ — SF Symbol (e.g., `sf:cylinder.fill`)
+- `separator_after` _(optional)_ — Add separator
+
+**Schedules** (cron jobs):
+- `name` — Display name
+- `command`, `args` — Command to run
+- `cron_schedule` — Cron expression (`minute hour day month weekday`)
+
+**Common cron patterns**:
+- `0 * * * *` — Every hour
+- `*/15 * * * *` — Every 15 minutes
+- `0 6 * * *` — Daily at 6am
+- `0 9 * * 1` — Mondays at 9am
+
+### SF Symbols (macOS icons)
+
+Common symbols for `group_icon`:
+- `sf:cylinder.fill` — Database
+- `sf:shippingbox.fill` — Cache/Redis
+- `sf:cloud.fill` — Cloud/Kubernetes
+- `sf:server.rack` — Server
+- `sf:network` — Network
+- `sf:clock.fill` — Scheduled tasks
+- `sf:hammer.fill` — Development
 
 Browse all symbols at [developer.apple.com/sf-symbols](https://developer.apple.com/sf-symbols/) or use the SF Symbols app.
 
-Restart the app to pick up configuration changes.
+Restart the app after editing the config.
 
 ## License