Add sponsor badge

Author: hyperpolymath

README.md

@@ -0,0 +1,172 @@
+[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath)
+
+// SPDX-License-Identifier: MPL-2.0
+
+= CloudGuard Server
+:toc: macro
+:toc-title: Contents
+:toclevels: 2
+
+REST + WebSocket API for Cloudflare domain security management.
+Enables external dashboards, CI/CD pipelines, and PanLL remote integration
+to audit, harden, and manage Cloudflare domains over HTTP.
+
+toc::[]
+
+== Overview
+
+CloudGuard Server wraps all CloudGuard operations as HTTP endpoints,
+providing a programmatic interface for tools that can't use the CLI
+directly. It includes WebSocket support for real-time progress updates
+during bulk operations.
+
+Companion projects:
+
+* **cloudguard-cli** — Command-line interface for terminal/CI use
+* **PanLL CloudGuard module** — GUI panel with three-panel compliance view
+
+== Installation
+
+=== From source
+
+[source,bash]
+----
+git clone https://github.com/hyperpolymath/cloudguard-server
+cd cloudguard-server
+cargo build --release
+# Binary at target/release/cloudguard-server
+----
+
+=== Environment
+
+[source,bash]
+----
+export CLOUDFLARE_API_TOKEN="your-token-here"
+
+# Optional: custom port (default 3847)
+export PORT=3847
+----
+
+=== Run
+
+[source,bash]
+----
+./target/release/cloudguard-server
+# CloudGuard Server listening on http://0.0.0.0:3847
+----
+
+== API Routes
+
+[cols="1,3,3"]
+|===
+| Method | Path | Description
+
+| GET
+| `/health`
+| Health check
+
+| GET
+| `/api/zones`
+| List all zones in the Cloudflare account
+
+| GET
+| `/api/zones/:id/settings`
+| Get all settings for a zone
+
+| GET
+| `/api/zones/:id/dns`
+| List DNS records for a zone
+
+| POST
+| `/api/zones/:id/dns`
+| Create a DNS record
+
+| DELETE
+| `/api/zones/:id/dns/:record_id`
+| Delete a DNS record
+
+| POST
+| `/api/zones/:id/harden`
+| Apply hardening settings to a zone
+
+| POST
+| `/api/zones/:id/audit`
+| Run compliance audit on a zone
+
+| POST
+| `/api/bulk/harden`
+| Bulk harden multiple zones
+
+| GET (WebSocket)
+| `/ws/bulk`
+| Real-time progress for bulk operations
+|===
+
+== Examples
+
+=== List zones
+
+[source,bash]
+----
+curl http://localhost:3847/api/zones
+----
+
+=== Audit a zone
+
+[source,bash]
+----
+curl -X POST http://localhost:3847/api/zones/ZONE_ID/audit
+----
+
+=== Bulk harden via REST
+
+[source,bash]
+----
+curl -X POST http://localhost:3847/api/bulk/harden \
+  -H "Content-Type: application/json" \
+  -d '{"zone_ids": ["id1", "id2", "id3"]}'
+----
+
+=== Bulk harden via WebSocket (real-time progress)
+
+[source,javascript]
+----
+const ws = new WebSocket("ws://localhost:3847/ws/bulk");
+ws.onmessage = (e) => console.log(JSON.parse(e.data));
+ws.onopen = () => ws.send(JSON.stringify({
+  action: "harden",
+  zone_ids: ["id1", "id2", "id3"]
+}));
+// Receives: { type: "progress", completed: 0, total: 3, current_zone: "id1" }
+// Receives: { type: "zone_complete", zone_id: "id1", status: "hardened", settings_updated: 17 }
+// ... per zone ...
+// Receives: { type: "complete", total: 3 }
+----
+
+== Response Format
+
+All endpoints return JSON with a consistent envelope:
+
+[source,json]
+----
+{
+  "success": true,
+  "result": { ... }
+}
+----
+
+On error:
+
+[source,json]
+----
+{
+  "success": false,
+  "error": "description of what went wrong"
+}
+----
+
+== License
+
+MPL-2.0
+
+Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath)