Update README.md

README.md

@@ -11,4 +11,36 @@ license: mit
 short_description: Keep MCP-birthday hackathon spaces availble
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# 🔄 Space Keeper
+
+Keeps HuggingFace Spaces alive during hackathon evaluation by pinging them on a schedule.
+
+## What it does
+
+- Automatically pings all Spaces in a specified organization every N hours
+- Prevents Spaces from sleeping due to inactivity
+- Logs all runs with success/failure status
+- Provides a manual "Run Now" button for immediate pings
+
+## Configuration
+
+Set these environment variables in your Space settings:
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `ORG_NAME` | `mcp-hackathon` | The HuggingFace organization to monitor |
+| `PING_INTERVAL_HOURS` | `6` | How often to ping (in hours) |
+| `REQUEST_TIMEOUT` | `30` | Timeout for each ping request (in seconds) |
+
+## Usage
+
+1. Create a new Space with this code
+2. Set the `ORG_NAME` environment variable to your hackathon org
+3. The Space will automatically ping all Spaces in that org every 6 hours
+4. Check the logs in the UI to verify everything is working
+
+## Notes
+
+- For ZeroGPU Spaces, you may want to reduce `PING_INTERVAL_HOURS` to 3 or 4
+- The Space stores logs in `run_logs.json` (kept for last 100 runs)
+- Logs persist as long as the Space is running