Janeka commited on
Commit
87ce57c
·
verified ·
1 Parent(s): c876557

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +24 -4
README.md CHANGED
@@ -1,12 +1,32 @@
1
  ---
2
  title: Background Remover
3
- emoji: 🌍
4
- colorFrom: green
5
- colorTo: yellow
6
  sdk: gradio
7
  sdk_version: 5.25.2
8
  app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: Background Remover
3
+ emoji: 🖼️
4
+ colorFrom: blue
5
+ colorTo: purple
6
  sdk: gradio
7
  sdk_version: 5.25.2
8
  app_file: app.py
9
  pinned: false
10
  ---
11
 
12
+ # Background Remover with Rembg
13
+
14
+ This Space removes backgrounds from images using Rembg and provides an API endpoint for integration with your apps.
15
+
16
+ ## Features
17
+ - Simple web interface for testing
18
+ - API endpoint at `/api/remove-bg`
19
+ - Fast background removal
20
+ - Supports all common image formats
21
+
22
+ ## How to Use the API
23
+ Send a POST request to `https://[your-space-name].hf.space/api/remove-bg` with:
24
+ - An image file in the request body (form-data)
25
+ - Key name: `file`
26
+
27
+ ### Example API Request (curl)
28
+ ```bash
29
+ curl -X POST \
30
+ -F "file=@your_image.jpg" \
31
+ https://[your-space-name].hf.space/api/remove-bg \
32
+ --output output.png