Upload README.md

README.md

@@ -1,12 +1,20 @@
 ---
 title: WaveSign API
-emoji: 📊
-colorFrom: indigo
-colorTo: purple
+emoji: 🔏
+colorFrom: blue
+colorTo: indigo
 sdk: docker
 pinned: false
-license: apache-2.0
-short_description: Invisible file signing and tamper detection for images& docs
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# WaveSign API
+
+Private API space — not publicly accessible.
+
+All endpoints (except `/health`) require an `Authorization: Bearer <key>` header matching the `WS_API_KEY` environment variable configured for this Space.
+
+## Endpoints
+
+- `GET /health` — liveness check, no auth required
+- `POST /sign` — sign an image or PDF; returns a ZIP containing the signed file and `sig.json`
+- `POST /verify` — verify a previously signed file against its `sig.json`; returns a JSON result