Update README.md

README.md

@@ -1,106 +1,55 @@
----
-title: RemBG_API
-emoji: 🖼️
-colorFrom: blue
-colorTo: purple
-sdk: docker
-sdk_version: 1.0.0
-app_file: fallback.py
-pinned: false
----
+# RemBG API Server
 
-# Background Removal API
-
-A simple API service that removes backgrounds from images.
+This is a Flask-based API server that removes backgrounds from images using the rembg library.
 
 ## Setup
 
 1. Install the required packages:
-```
+```bash
 pip install -r requirements.txt
 ```
 
-2. Run the server:
-```
-uvicorn fallback:app --host 0.0.0.0 --port 7860
-```
-
-The server will start on port 7860.
+2. Configure the environment:
+- Copy `.env.example` to `.env`
+- Set your desired API key in the `.env` file
 
-## 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.
+3. Run the server:
+```bash
+python app.py
+```
 
-**Request:**
-- Form data with a file field named "file" containing the image
+## API Usage
 
-**Response:**
-- PNG image with transparent background
+### Remove Background
+- Endpoint: `POST /remove-bg`
+- Headers:
+  - `X-API-Key`: Your API key
+- Body: Form-data with an 'image' file
+- Returns: PNG image with background removed
 
-## Example Usage
+### Health Check
+- Endpoint: `GET /health`
+- Returns: Health status of the server
 
-Using curl:
+## Example Usage with cURL
 ```bash
-curl -X POST -F "file=@your_image.jpg" http://localhost:7860/remove-bg -o result.png
+curl -X POST -H "X-API-Key: your-api-key" -F "image=@path/to/your/image.jpg" http://localhost:5000/remove-bg -o output.png
 ```
 
-Using Python requests:
+## Example Usage with Python
 ```python
 import requests
 
-url = "http://localhost:7860/remove-bg"
-files = {"file": open("your_image.jpg", "rb")}
-response = requests.post(url, files=files)
+url = "http://localhost:5000/remove-bg"
+headers = {
+    "X-API-Key": "your-api-key"
+}
 
-with open("result.png", "wb") as f:
-    f.write(response.content)
-```
+with open("input.jpg", "rb") as f:
+    files = {"image": f}
+    response = requests.post(url, headers=headers, files=files)
 
-## 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 "Docker" 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:
+if response.status_code == 200:
+    with open("output.png", "wb") as f:
+        f.write(response.content)
 ```
-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
-
-#### Numba/Rembg Issues
-
-If you encounter issues with Numba caching or the rembg library:
-
-1. The main.py file includes a fix that disables Numba JIT compilation
-2. If issues persist, you can use the fallback.py version (currently active)
-   ```
-   # Update the app_file in README.md
-   app_file: fallback.py
-   ```
-   
-   And update the Dockerfile:
-   ```
-   # Change the CMD line in Dockerfile
-   CMD ["uvicorn", "fallback:app", "--host", "0.0.0.0", "--port", "7860"]
-   ```
-
-The fallback version doesn't actually remove backgrounds but provides a compatible API.