Merge pull request #328 from txn2/docs

Documentation website updates

Author: cjimti

README.md

@@ -10,6 +10,8 @@
 [![Docker Pulls](https://img.shields.io/docker/pulls/txn2/kubefwd)](https://hub.docker.com/r/txn2/kubefwd)
 [![GitHub Downloads](https://img.shields.io/github/downloads/txn2/kubefwd/total)](https://github.com/txn2/kubefwd/releases)
 
+**[Documentation](https://kubefwd.com)** | **[Getting Started](https://kubefwd.com/getting-started/)** | **[TUI Guide](https://kubefwd.com/tui-guide/)**
+
 ## Develop Locally, Connect to Kubernetes
 
 **kubefwd** enables developers to work on their local machine while seamlessly accessing services running in a Kubernetes cluster. If you're building a new API that needs to connect to a database at `db:5432`, an auth service at `auth:443`, and a cache at `redis:6379`, all running in your development cluster, kubefwd makes them available locally by their service names, exactly as they would appear in-cluster. No environment-specific configuration, no local service setup, no Docker Compose files. Just run `kubefwd` and your application's existing connection strings work.
@@ -126,9 +128,7 @@ Download from [releases](https://github.com/txn2/kubefwd/releases):
 
 ### Windows
 
-```batch
-scoop install kubefwd
-```
+Download from [releases](https://github.com/txn2/kubefwd/releases) - extract `kubefwd.exe` and run as Administrator.
 
 ### Docker
 

docs/getting-started.md

@@ -52,17 +52,13 @@ sudo mv kubefwd /usr/local/bin/
 
 ### Windows
 
-Using [Scoop](https://scoop.sh/):
+Download the Windows executable from [GitHub Releases](https://github.com/txn2/kubefwd/releases/latest):
 
-```batch
-scoop install kubefwd
-```
-
-To upgrade:
+1. Download `kubefwd_Windows_x86_64.zip`
+2. Extract `kubefwd.exe`
+3. Add to your PATH or run directly
 
-```batch
-scoop update kubefwd
-```
+Run as Administrator (required for hosts file access).
 
 ### Docker
 

docs/images/bg-mirror.jpg

@@ -1,125 +1,74 @@
-# kubefwd Documentation
-
-> Bulk Kubernetes port forwarding with an interactive TUI, unique IPs per service, and automatic reconnection.
-
-![kubefwd TUI](images/tui-110-main-active.png)
-
-## What is kubefwd?
-
-kubefwd is a command-line tool that bulk-forwards Kubernetes services to your local machine. Unlike `kubectl port-forward`, kubefwd:
-
-- Forwards **all services** in a namespace with one command
-- Assigns **unique IP addresses** (127.x.x.x) to each service
-- Updates `/etc/hosts` so you can use **service names** directly
-- Provides an **interactive TUI** with real-time metrics
-- **Auto-reconnects** when pods restart
-
-## Quick Start
+---
+title: kubefwd
+description: Bulk port forward Kubernetes services for local development
+hide:
+  - navigation
+  - toc
+---
+
+<div class="home-hero">
+  <img src="images/brand-text-800-blk.png" alt="kubefwd" class="hero-logo hero-logo-light">
+  <img src="images/brand-text-800.png" alt="kubefwd" class="hero-logo hero-logo-dark">
+</div>
+
+<div class="home-intro">
+  <p><strong>kubefwd</strong> enables developers to work locally while accessing services running in Kubernetes. Connect to <code>db:5432</code>, <code>auth:443</code>, <code>redis:6379</code>, all by service name, exactly as in-cluster. No environment config, no Docker Compose. Just run kubefwd.</p>
+</div>
+
+<div class="home-buttons">
+  <a href="getting-started/" class="btn btn-primary">Get Started</a>
+  <a href="https://github.com/txn2/kubefwd" class="btn btn-secondary">GitHub</a>
+</div>
+
+<div class="home-screenshot">
+  <img src="images/tui-110-main-active.png" alt="kubefwd TUI">
+</div>
+
+<div class="home-features">
+  <div class="feature">
+    <span class="feature-icon">🔌</span>
+    <div>
+      <strong>Unique IP per Service</strong>
+      <span>Each service gets its own 127.x.x.x. Multiple databases on port 3306? No conflicts.</span>
+    </div>
+  </div>
+  <div class="feature">
+    <span class="feature-icon">🔄</span>
+    <div>
+      <strong>Auto-Reconnect</strong>
+      <span>Pods restart? kubefwd reconnects automatically with exponential backoff.</span>
+    </div>
+  </div>
+  <div class="feature">
+    <span class="feature-icon">📊</span>
+    <div>
+      <strong>Interactive TUI</strong>
+      <span>Real-time status, traffic metrics, and pod logs in your terminal.</span>
+    </div>
+  </div>
+  <div class="feature">
+    <span class="feature-icon">🌐</span>
+    <div>
+      <strong>Service Names Work</strong>
+      <span>Updates /etc/hosts so any app can access services by name.</span>
+    </div>
+  </div>
+</div>
+
+<div class="home-install">
 
 ```bash
-# Install
+# macOS
 brew install txn2/tap/kubefwd
 
-# Forward all services with the TUI
+# Then forward services
 sudo -E kubefwd svc -n my-namespace --tui
 ```
 
-Access services by name:
-
-```bash
-curl http://api-service:8080
-mysql -h database -P 3306
-```
-
-## Documentation
-
-### Getting Started
-
-- [Installation & Quick Start](getting-started.md) - Get up and running
-
-### Using kubefwd
-
-- [TUI Guide](tui-guide.md) - Interactive interface, keyboard shortcuts
-- [Configuration](configuration.md) - All command line flags and options
-- [Advanced Usage](advanced-usage.md) - Multi-namespace, multi-cluster, Docker
-
-### Reference
-
-- [Troubleshooting](troubleshooting.md) - Common issues and solutions
-- [Architecture](architecture.md) - How kubefwd works under the hood
-- [Comparison](comparison.md) - kubefwd vs Telepresence, mirrord, Gefyra
-
-## Key Features
-
-### Interactive TUI
-
-The Terminal User Interface provides:
-- Real-time service status monitoring
-- Traffic metrics with sparkline graphs
-- Pod log streaming
-- Keyboard-driven navigation
-
-Press `?` for help, `q` to quit.
-
-### Unique IP per Service
-
-Each service gets its own loopback IP (127.1.27.x), eliminating port conflicts:
-
-```
-127.1.27.1    api-service
-127.1.27.2    database
-127.1.27.3    cache
-```
-
-Multiple services can use the same port (e.g., several databases on 3306).
-
-### Automatic Reconnection
-
-With `--tui` or `-a`, kubefwd automatically reconnects when:
-- Pods are restarted
-- Connections drop
-- Services are updated
-
-Uses exponential backoff (1s → 5min max).
-
-### Headless Service Support
-
-For headless services (ClusterIP: None), kubefwd forwards all pods:
-- `service-name` → first pod
-- `pod-name.service-name` → specific pods
-
-Essential for StatefulSets and database clusters.
-
-## Comparison with kubectl
-
-| Feature | kubectl port-forward | kubefwd |
-|---------|---------------------|---------|
-| Services per command | One | All in namespace |
-| IP allocation | localhost only | Unique IP per service |
-| Port conflicts | Manual management | None |
-| Service name resolution | Not supported | Automatic |
-| Auto-reconnect | No | Yes |
-| Monitoring | None | TUI with metrics |
-
-## Installation Options
-
-| Platform | Command |
-|----------|---------|
-| macOS | `brew install txn2/tap/kubefwd` |
-| Linux | Download from [releases](https://github.com/txn2/kubefwd/releases) |
-| Windows | `scoop install kubefwd` |
-| Docker | `docker run txn2/kubefwd ...` |
-
-See [Getting Started](getting-started.md) for details.
-
-## Requirements
-
-- kubectl configured with cluster access
-- Root/sudo access (required for /etc/hosts and network interfaces)
-
-## Source Code
-
-kubefwd is open source under the Apache 2.0 license.
+</div>
 
-- GitHub: [https://github.com/txn2/kubefwd](https://github.com/txn2/kubefwd)
-- Issues: [https://github.com/txn2/kubefwd/issues](https://github.com/txn2/kubefwd/issues)
+<div class="home-footer">
+  <a href="https://github.com/txn2/kubefwd/releases"><img src="https://img.shields.io/github/release/txn2/kubefwd.svg?style=flat-square" alt="Release"></a>
+  <a href="https://github.com/txn2/kubefwd"><img src="https://img.shields.io/github/stars/txn2/kubefwd?style=flat-square" alt="Stars"></a>
+  <p>Open source by <a href="https://twitter.com/cjimti">Craig Johnston</a></p>
+</div>