Update README.md

README.md

@@ -10,3 +10,38 @@ pinned: false
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+## Cursor AI Proxy with Checksum
+
+This is a modified version of the Cursor AI proxy that includes a checksum mechanism for enhanced security.
+
+**Features:**
+
+*   Proxies requests from Cursor to OpenAI API.
+*   Fetches the latest checksum from `https://cc.wisdgod.com/get-checksum` every 3 hours.
+*   Verifies the checksum of incoming requests on the `/hf/v1/chat/completions` endpoint.
+
+**How to Use:**
+
+1. **Set the `CURSOR_CHECKSUM` Environment Variable:**
+    *   In your Hugging Face Space's Settings, go to "Repository secrets" and add a new secret:
+        *   **Name:** `CURSOR_CHECKSUM`
+        *   **Value:** You can set an initial checksum value here, or leave it blank to initially rely on the value fetched from `https://cc.wisdgod.com/get-checksum`.
+2. **Deploy to Hugging Face Spaces:**
+    *   Commit and push the `hf.js` and `Dockerfile` to your Hugging Face Space's Git repository.
+    *   Hugging Face will automatically build and deploy your application.
+
+**Checksum Verification:**
+
+*   The application fetches the latest checksum from `https://cc.wisdgod.com/get-checksum` on startup and every 3 hours.
+*   Incoming requests to `/hf/v1/chat/completions` are checked against the current `checksumValue`.
+*   If the checksum doesn't match, a `400 Invalid checksum` error is returned.
+
+**Important Notes:**
+
+*   The `verifyChecksum()` function in `hf.js` is a **placeholder**. You need to implement the actual checksum verification logic based on your security requirements and how Cursor sends data.
+*   The current example uses a simple string comparison for demonstration purposes. You should use a robust cryptographic algorithm like HMAC for production environments.
+
+**Disclaimer:**
+
+This modified proxy is provided as-is. Use it at your own risk. Always thoroughly test your code and security measures before deploying to production.