Tidy README structure

exploded · claude · exploded · commit 53b90bd26f88 · 2026-02-24T20:22:51.000+11:00
- Move GitHub secrets and deployment trigger into a dedicated Deployment section
- Add Configuration parent heading for Environment Variables and Server Settings
- Fix Windows Development code block indentation
- Normalise copyright years to 2020-2026

Co-Authored-By: Claude Sonnet 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/README.md b/README.md
@@ -8,11 +8,7 @@ A web application that calculates and displays moon rise and set times for any l
 - Automatic geolocation detection
 - Smart timezone selector with auto-detection and 50+ timezones
 - Real-time moon rise and set calculations
-- 10-day calendar view with sun and moon times
-- Fully responsive design for mobile and desktop
-- Security headers and CSP protection
-- Static asset caching for performance
-- ARIA accessibility features
+- Full month calendar view with sun and moon times
 
 ## Technology Stack
 
@@ -21,11 +17,6 @@ A web application that calculates and displays moon rise and set times for any l
 - **Maps**: Google Maps JavaScript API with AdvancedMarkerElement
 - **Calculations**: [riseset](https://github.com/exploded/riseset) library
 
-## Prerequisites
-
-- Go 1.21 or higher
-- Google Maps API key with Maps JavaScript API enabled
-
 ## Local Development
 
 1. **Clone the repository**
@@ -40,10 +31,8 @@ A web application that calculates and displays moon rise and set times for any l
    ```
 
 3. **Set up environment variables**
-   ```bash
-   cp .env.example .env
-   ```
-   Edit `.env` and set your values:
+   Use .env.example to create your own .env file
+
    ```env
    GOOGLE_MAPS_API_KEY=your_actual_api_key_here
    PROD=False
@@ -61,43 +50,20 @@ A web application that calculates and displays moon rise and set times for any l
        - For local development: `http://localhost:8484/*`
      - **API restrictions**: Restrict key to "Maps JavaScript API" only
      - Set usage quotas to prevent abuse
-   
-   > **Security Note**: Google Maps JavaScript API keys are client-side visible by design. The security comes from properly configuring API key restrictions in Google Cloud Console, not from hiding the key.
-
-## Running the Application
-
-### Development
 
-```bash
-# Load environment variables and run
-go run moon.go
-```
-
-The server will start on `http://localhost:8484`
+   > **Security Note**: Google Maps JavaScript API keys are client-side visible by design. The security comes from properly configuring API key restrictions in Google Cloud Console, not from hiding the key.
 
 ### Windows Development
 
-Use the provided batch files:
-
-1. **First time setup:**
-   ```cmd
-   build.bat
-   ```
-   This will:
-   - Build the application
-   - Create `.env` from `.env.example` if missing
-   - Prompt you to add your API key
+```cmd
+build.bat
+```
 
-2. **Edit `.env`** and replace the placeholder with your actual API key
+Or for quick restart (when already built):
 
-3. **Run the application:**
-   ```cmd
-   build.bat
-   ```
-   or for quick restart (when already built):
-   ```cmd
-   run.bat
-   ```
+```cmd
+run.bat
+```
 
 ### Cross-Compilation (Building for Linux from Windows)
 
@@ -108,220 +74,21 @@ set GOARCH=amd64
 go build -o moon
 ```
 
-**Build for Debian/Ubuntu (arm64 - Raspberry Pi, etc):**
-```cmd
-set GOOS=linux
-set GOARCH=arm64
-go build -o moon
-```
-
 **Build for Windows (local):**
 ```cmd
 set GOOS=windows
 set GOARCH=amd64
 go build -o moon.exe
 ```
 
-Or use PowerShell:
-```powershell
-$env:GOOS="linux"; $env:GOARCH="amd64"; go build -o moon
-```
-
-Then upload the `moon` binary to your Debian server.
-
-### Production
-
-```bash
-# Build the binary
-go build -o moon
-
-# Set environment variables
-export GOOGLE_MAPS_API_KEY="your_key_here"
-export PROD="True"
-
-# Run the server
-./moon
-```
-
-### Using systemd (Linux)
-
-1. Build and install the binary:
-   ```bash
-   go run moon.go
-   ```
-   The server starts on `http://localhost:8484`
-
-### Google Maps API Key
-
-- Go to [Google Cloud Console](https://console.cloud.google.com/)
-- Enable "Maps JavaScript API" and create an API key
-- Restrict the key to HTTP referrers (`http://localhost:8484/*` for dev, your domain for prod) and to "Maps JavaScript API" only
-
-4. Install and enable the service:
-   ```bash
-   sudo cp moon.service /etc/systemd/system/
-   sudo systemctl daemon-reload
-   sudo systemctl enable moon
-   sudo systemctl start moon
-   sudo systemctl status moon
-   ```
-
-### Debian/Ubuntu Production Deployment
-
-#### 1. Deploy Application
-
-```bash
-# Create application directory
-sudo mkdir -p /var/www/moon
-sudo chown $USER:$USER /var/www/moon
-
-# Clone or copy your application
-cd /var/www/moon
-# ... copy your files here ...
-
-# Install dependencies
-go mod download
-
-# Build the application
-go build -o moon
-
-# Make executable
-chmod +x moon
-```
-
-#### 2. Build and Install Binary
-
-```bash
-# Build for Linux (if cross-compiling from Windows, see Cross-Compilation section)
-cd /var/www/moon
-go build -o moon
-
-# Install binary to system location
-sudo cp moon /usr/local/bin/moon
-sudo chmod +x /usr/local/bin/moon
-```
-
-#### 3. Create Environment File
-
-```bash
-sudo nano /usr/local/bin/moon-env
-```
-
-Add:
-```env
-GOOGLE_MAPS_API_KEY=your_actual_api_key_here
-PROD=True
-```
-
-```bash
-sudo chmod 600 /usr/local/bin/moon-env
-```
-
-#### 4. Install and Start systemd Service
-
-```bash
-# Copy service file
-sudo cp moon.service /etc/systemd/system/
-
-# Set proper ownership for working directory
-sudo chown -R www-data:www-data /var/www/moon
-
-# Reload systemd
-sudo systemctl daemon-reload
-
-# Enable and start
-sudo systemctl enable moon
-sudo systemctl start moon
-
-# Check status
-sudo systemctl status moon
-
-# View logs
-sudo journalctl -u moon -f
-```
-
-#### 5. Configure Nginx Reverse Proxy (Optional)
-
-Install Nginx:
-```bash
-sudo apt install nginx -y
-```
-
-Create site configuration:
-```bash
-sudo nano /etc/nginx/sites-available/moon
-```
-
-```nginx
-server {
-    listen 80;
-    server_name your-domain.com;
-
-    location / {
-        proxy_pass http://localhost:8484;
-        proxy_http_version 1.1;
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Connection 'upgrade';
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarded-Proto $scheme;
-        proxy_cache_bypass $http_upgrade;
-    }
-}
-```
-
-Enable site:
-```bash
-sudo ln -s /etc/nginx/sites-available/moon /etc/nginx/sites-enabled/
-sudo nginx -t
-sudo systemctl restart nginx
-```
-
-#### 6. Setup SSL with Let's Encrypt (Optional)
-
-```bash
-# Install certbot
-sudo apt install certbot python3-certbot-nginx -y
-
-# Obtain certificate
-sudo certbot --nginx -d your-domain.com
-
-# Auto-renewal is configured automatically
-# Test renewal:
-sudo certbot renew --dry-run
-```
-
-#### 7. Firewall Configuration
-
-```bash
-# If using UFW
-sudo ufw allow 'Nginx Full'
-sudo ufw allow OpenSSH
-sudo ufw enable
-sudo ufw status
-```
-
-## CI/CD Deployment (GitHub Actions → Linode)
-
-Every push to `master` automatically runs tests, builds a Linux binary, and deploys it to your Linode server via SSH.
-
-### How it works
-
-1. GitHub Actions runs `go test`
-2. If tests pass, it cross-compiles a Linux amd64 binary
-3. It SCPs the binary and web assets to the server
-4. It SSHs in, installs the files, and restarts the systemd service
-
-### One-time server setup
-
-Run the provided setup script **once** on your Linode server:
+## Testing
 
 ```bash
-sudo bash scripts/server-setup.sh
+go test -v
+go test -cover
 ```
 
-This creates a `deploy` user with SSH keys and the minimal sudoers permissions needed for deployment, then prints the secrets to add to GitHub.
+## Deployment
 
 ### GitHub repository secrets
 
@@ -342,46 +109,6 @@ git push origin master
 
 View deployment logs at `https://github.com/exploded/moon/actions`
 
-## Testing
-
-```bash
-go test -v
-go test -cover
-```
-
-## Project Structure
-
-```
-moon/
-├── moon.go                          # Main server application
-├── moon_test.go                     # Unit tests
-├── index.html                       # Home page
-├── about.html                       # About page
-├── calendar.html                    # Calendar view
-├── static/
-│   ├── styles.css                   # Global styles
-│   ├── script.js                    # Client-side JavaScript
-│   └── moon.jpg                     # Background image
-├── .github/
-│   └── workflows/
-│       └── deploy.yml               # GitHub Actions CI/CD pipeline
-├── scripts/
-│   └── server-setup.sh              # One-time Linode server setup
-├── go.mod                           # Go module dependencies
-├── .env.example                     # Environment variables template
-├── .gitignore                       # Git ignore rules
-├── moon.service                     # systemd service file
-└── README.md                        # This file
-```
-
-## API Endpoints
-
-- `GET /` - Home page with map interface
-- `GET /about` - About page
-- `GET /calendar` - Calendar view (query params: lat, lon, zon)
-- `GET /gettimes` - JSON API for moon times (query params: lat, lon, zon)
-- `GET /static/*` - Static assets (cached 7 days)
-
 ## Configuration
 
 ### Environment Variables
@@ -409,19 +136,9 @@ moon/
 - Graceful shutdown on SIGTERM/SIGINT
 - API key injected via server-side template rendering (not exposed via endpoint)
 
-## Browser Support
-
-Chrome/Edge, Firefox, Safari (all latest), iOS Safari, Chrome Mobile.
-
-## Known Limitations
-
-- Calendar view shows 10 days from current date
-- Requires JavaScript enabled
-- Geolocation requires HTTPS in production
-
 ## License
 
-Copyright 2020, 2023, 2026 James McHugh
+Copyright 2020–2026 James McHugh
 
 Licensed under the Apache License, Version 2.0. See [LICENSE](http://www.apache.org/licenses/LICENSE-2.0).
 
