Update README.md

README.md

@@ -1,14 +1,78 @@
----
-title: RemBG API
-emoji: 📈
-colorFrom: blue
-colorTo: pink
-sdk: gradio
-sdk_version: 5.34.0
-app_file: app.py
-pinned: false
-license: mit
-short_description: rembg-api
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Background Removal API
+
+A simple API service that removes backgrounds from images.
+
+## Setup
+
+1. Install the required packages:
+```
+pip install -r requirements.txt
+```
+
+2. Run the server:
+```
+uvicorn main:app --host 0.0.0.0 --port 7860
+```
+
+The server will start on port 7860.
+
+## API Endpoints
+
+### GET /
+Returns a status message indicating the API is running or redirects to the web interface.
+
+### GET /health
+Returns health check information about the API.
+
+### POST /remove-bg
+Removes the background from an uploaded image.
+
+**Request:**
+- Form data with a file field named "file" containing the image
+
+**Response:**
+- PNG image with transparent background
+
+## Example Usage
+
+Using curl:
+```bash
+curl -X POST -F "file=@your_image.jpg" http://localhost:7860/remove-bg -o result.png
+```
+
+Using Python requests:
+```python
+import requests
+
+url = "http://localhost:7860/remove-bg"
+files = {"file": open("your_image.jpg", "rb")}
+response = requests.post(url, files=files)
+
+with open("result.png", "wb") as f:
+    f.write(response.content)
+```
+
+## Deployment on Hugging Face Spaces
+
+This API is designed to be compatible with Hugging Face Spaces. The server runs on port 7860 by default.
+
+To deploy to Hugging Face Spaces:
+1. Create a new Space with the "FastAPI" SDK
+2. Upload all these files to the Space
+3. The API will be available at: https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME
+
+Example API URL for background removal:
+```
+https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME/remove-bg
+```
+
+### Troubleshooting Hugging Face Spaces Deployment
+
+If you encounter issues with the deployment:
+
+1. Check the health endpoint: `/health`
+2. Make sure all required dependencies are installed
+3. Verify the static directory exists and contains the index.html file
+4. Check the Hugging Face Spaces logs for any error messages
+
+The API is configured to provide detailed debugging information to help diagnose issues.