Update README.md

README.md

@@ -1,10 +1,39 @@
 ---
-title: Newapi
-emoji: 🐨
-colorFrom: yellow
-colorTo: pink
+title: My New API Deployment
+emoji: 🚀
+colorFrom: indigo
+colorTo: green
 sdk: docker
-pinned: false
+app_port: 3000 # Corresponds to "3000:3000" in your docker-compose.yml for the new-api service's container port
+persistent_storage:
+  new_api_data: # This is a name for your persistent storage volume
+    mount_path: /data   # Mounts the persistent storage to /data inside the container (for ./data:/data)
+  new_api_logs: # Persistent storage for logs
+    mount_path: /app/logs # Mounts to /app/logs inside the container (for ./logs:/app/logs)
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+## New API Deployment on Hugging Face Spaces
+
+This Space runs the `new-api` application.
+
+**IMPORTANT SETUP REQUIRED:**
+
+This application relies on external Redis and MySQL services. You **must** configure these yourself and then set the appropriate connection strings in this Space's "Settings" tab, under "Secrets".
+
+1.  **Provision External Services:**
+    *   Create a **Redis** instance (e.g., on Aiven, Upstash, or your preferred cloud provider).
+    *   Create a **MySQL 8.2+** instance (e.g., on Aiven, PlanetScale, or your preferred cloud provider). Ensure you create a database named `new-api` (or whatever your `SQL_DSN` will point to) and have the root password or a dedicated user/password.
+
+2.  **Configure Space Secrets:**
+    In this Space's "Settings" > "Secrets", add the following:
+    *   `REDIS_CONN_STRING`: The full connection string for your external Redis.
+        *   Example: `redis://your-redis-host:your-redis-port` or `redis://user:password@host:port`
+    *   `SQL_DSN`: The DSN for your external MySQL database.
+        *   **Crucially, replace `mysql:3306` with your actual external MySQL host and port.**
+        *   Example: `root:YOUR_MYSQL_ROOT_PASSWORD@your-external-mysql-host:3306/new-api`
+        *   Ensure the password (`YOUR_MYSQL_ROOT_PASSWORD`) matches the one you set for your external MySQL.
+    *   `TZ`: (Can be a Variable or Secret) `Asia/Shanghai`
+    *   `SESSION_SECRET`: (Secret, if you plan to scale or for security) A long random string.
+    *   `CRYPTO_SECRET`: (Secret, if needed by your configuration) Another long random string.
+
+Once the `Dockerfile`, `README.md` are pushed, and the secrets are configured, Hugging Face Spaces will attempt to build and run your `new-api` container.