Skip to content

Commit 010d63b

Browse files
committed
docs(quick-001): update README with comprehensive feature documentation
- Added Image Editing Modal section with full-screen editor details - Documented background selection (12 presets, custom, image upload) - Added background filters (brightness, contrast, saturation, blur) - Documented transform controls (zoom 0.5x-3.0x, rotate, flip) - Added aspect ratio cropping with 6 options and interactive overlay - Documented Export Modal with Ko-fi integration - Updated project structure with all new components - Enhanced How It Works section with editing workflow - Updated Overview to mention editing capabilities
1 parent 47579f7 commit 010d63b

File tree

1 file changed

+51
-16
lines changed

1 file changed

+51
-16
lines changed

README.md

Lines changed: 51 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,35 @@
1010

1111
## Overview
1212

13-
Clearcut is a privacy-first background removal tool that runs entirely in your browser. No uploads, no servers, no subscriptions - just instant, studio-quality results powered by AI.
13+
Clearcut is a privacy-first background removal and image editing tool that runs entirely in your browser. No uploads, no servers, no subscriptions - just instant, studio-quality results powered by AI. Remove backgrounds, apply custom backgrounds, adjust filters, transform images, and crop to specific aspect ratios - all without your images ever leaving your device.
1414

1515
### Key Features
1616

1717
- **100% Private** - Your images never leave your device. All processing happens locally in your browser.
1818
- **Unlimited & Free** - No usage limits, no watermarks, no accounts required.
1919
- **Instant Processing** - Powered by WebGPU/WASM for fast inference.
2020
- **Studio-Grade Quality** - Uses the RMBG-1.4 model for precise edge detection and hair handling.
21+
22+
#### Background Removal & Editing
2123
- **Brush Editing** - Fine-tune results with erase/restore brush tools.
22-
- **Background Replacement** - Add solid colors or custom images as backgrounds.
23-
- **High-Res Export** - Download full-resolution PNG or JPG files.
24+
- **Undo/Redo** - Up to 20 history entries for brush edits.
25+
- **Before/After Comparison** - Interactive slider to compare original and edited images.
26+
27+
#### Image Editing Modal
28+
- **Full-Screen Editor** - Immersive editing experience with real-time preview.
29+
- **Background Selection** - Choose from 12 preset colors, custom color picker, or upload your own background image.
30+
- **Background Filters** - Adjust brightness (0-200%), contrast (0-200%), saturation (0-200%), and blur (0-20px) on backgrounds.
31+
- **Transform Controls**:
32+
- Zoom: 0.5x to 3.0x with interactive canvas zoom (zoom toward cursor position).
33+
- Rotate: 90-degree increments left or right.
34+
- Flip: Horizontal and vertical mirroring with active state indicators.
35+
- **Aspect Ratio Cropping** - Interactive crop tool with 6 aspect ratio options (Original, Free, 1:1, 4:3, 16:9, 9:16).
36+
- **Crop Overlay** - Visual crop handles with rule of thirds grid for composition.
37+
- **Real-Time Preview** - See all edits applied instantly on the canvas.
38+
39+
#### Export
40+
- **Export Modal** - Loading states, success confirmation, and Ko-fi support prompt.
41+
- **High-Res Export** - Download full-resolution PNG or JPG files with original filename + "-nobg" suffix.
2442

2543
---
2644

@@ -77,22 +95,38 @@ clearcut/
7795
│ └── favicon.svg
7896
├── src/
7997
│ ├── components/
80-
│ │ ├── landing/ # Landing page components
81-
│ │ ├── remove/ # Background removal UI
82-
│ │ └── ui/ # Reusable UI components
98+
│ │ ├── landing/ # Landing page components
99+
│ │ ├── remove/ # Background removal & editing UI
100+
│ │ │ ├── BackgroundRemover.tsx # Main orchestrator
101+
│ │ │ ├── UploadZone.tsx # Image upload
102+
│ │ │ ├── ProcessingState.tsx # Loading states
103+
│ │ │ ├── ResultsView.tsx # Results display
104+
│ │ │ ├── EditingView.tsx # Brush editing view
105+
│ │ │ ├── ComparisonSlider.tsx # Before/after slider
106+
│ │ │ ├── BrushPanel.tsx # Brush controls
107+
│ │ │ ├── BackgroundPanel.tsx # Background controls
108+
│ │ │ ├── EditModal.tsx # Full-screen editor
109+
│ │ │ ├── EditPreview.tsx # Interactive canvas preview
110+
│ │ │ ├── ExportModal.tsx # Export flow with Ko-fi
111+
│ │ │ ├── BackgroundSelector.tsx # Preset/custom backgrounds
112+
│ │ │ ├── FilterControls.tsx # BG filter sliders
113+
│ │ │ └── TransformControls.tsx # Zoom/rotate/flip/crop
114+
│ │ └── ui/ # Reusable UI components
83115
│ ├── lib/
84-
│ │ ├── segmentation.ts # AI model integration
85-
│ │ ├── compositing.ts # Canvas rendering & export
86-
│ │ └── brushTool.ts # Brush editing utilities
116+
│ │ ├── segmentation.ts # AI model integration
117+
│ │ ├── compositing.ts # Canvas rendering & export
118+
│ │ ├── brushTool.ts # Brush editing utilities
119+
│ │ ├── imageFilters.ts # CSS filter utilities
120+
│ │ └── imageTransforms.ts # Canvas transform utilities
87121
│ ├── stores/
88-
│ │ └── appStore.ts # Zustand state management
122+
│ │ └── appStore.ts # Zustand state management
89123
│ ├── layouts/
90-
│ │ └── Layout.astro # Base HTML layout
124+
│ │ └── Layout.astro # Base HTML layout
91125
│ ├── pages/
92-
│ │ ├── index.astro # Landing page
93-
│ │ └── remove.astro # Background removal tool
126+
│ │ ├── index.astro # Landing page
127+
│ │ └── remove.astro # Background removal tool
94128
│ └── styles/
95-
│ └── global.css # Tailwind & global styles
129+
│ └── global.css # Tailwind & global styles
96130
├── astro.config.mjs
97131
├── tailwind.config.js
98132
└── package.json
@@ -105,8 +139,9 @@ clearcut/
105139
1. **Model Loading** - On first visit, the RMBG-1.4 model (~45MB) is downloaded and cached in your browser.
106140
2. **Image Processing** - When you upload an image, it's processed entirely client-side using WebGPU (if available) or WASM.
107141
3. **Mask Generation** - The AI generates a segmentation mask identifying foreground vs background.
108-
4. **Compositing** - The mask is applied to create a transparent background, with optional color/image replacement.
109-
5. **Export** - The final result is rendered to a canvas and exported as PNG/JPG.
142+
4. **Image Editing** - Open the full-screen editor to apply background replacements, filters (brightness, contrast, saturation, blur), transforms (zoom, rotate, flip), and crop to specific aspect ratios.
143+
5. **Compositing** - The mask is applied to create a transparent background, with optional color/image replacement and filters.
144+
6. **Export** - Click the download button to trigger the export modal. The final result is rendered to a canvas and exported as PNG/JPG with the original filename + "-nobg" suffix.
110145

111146
**No data ever leaves your browser.**
112147

0 commit comments

Comments
 (0)