docs: add README.md with project overview, features, and setup instructions

2026-07-06 00:47:36 -05:00
parent a281b7deeb
commit 1e23efd829
1 changed files with 41 additions and 0 deletions
@@ -0,0 +1,41 @@
+# CollisionStoneGuard (CSG) Image Tool
+
+The CSG Image Tool is a streamlined local web application designed to process and upload product photos directly to a WooCommerce store. It simplifies the workflow of importing, processing (background removal, watermarking), and uploading images.
+
+## Features
+
+### 1. 🚀 Quick Start Local Server
+- **`start.bat` Launcher:** Automatically detects Python or Node.js on your machine to start a local web server (required for API access and image processing capabilities) and opens the application in your default browser.
+
+### 2. 📥 Import
+- **Drag & Drop:** Easily drag and drop images directly into the browser.
+- **Folder Support:** Select individual files or entire folders of images at once.
+
+### 3. 🛠️ Image Processing & Batch Editing
+- **Background Removal:** Automatically removes photo backgrounds. Includes an adjustable color tolerance slider for precision.
+- **Center & Crop:** Automatically crops to the subject and centers it on a square canvas.
+- **Drop Shadow:** Adds a soft, professional drop shadow to the subject.
+- **Solid Black (Silhouette):** Turn parts into a solid black silhouette (ideal for black objects with glare).
+- **Watermarking:** Automatically overlays the CSG watermark. Includes options to upload custom watermarks, change opacity, and adjust size.
+- **Adjustable Quality & Size:** Slider for image quality (compression) and options to set the maximum image dimension to keep file sizes optimized.
+
+### 4. 🎨 Individual Image Editor
+Access the editor to fine-tune individual photos:
+- **Move Watermark:** Click and drag the logo to reposition it per image.
+- **Box & Lasso Cutout:** Draw a rectangle or freehand shape to clear anything outside the subject.
+- **Lasso Erase:** Draw a shape around leftover shadows or background artifacts to manually delete them.
+- **Nudge Part:** Click and drag the product to fine-tune its position in the frame.
+- **White Preview:** Toggle a solid white background instead of the transparent checkerboard for a better preview.
+- **Reset:** Undo manual changes on an image-by-image basis.
+
+### 5. ☁️ Direct WooCommerce Upload
+- **WooCommerce REST API Integration:** Configure your Site URL, Consumer Key, and Consumer Secret to upload processed photos directly to your store.
+- **WordPress Application Passwords:** Support for WP Auth to bypass 401 Unauthorized errors when uploading to the Media Library.
+- **Upload Log:** Real-time logging of upload success or failure for bulk jobs.
+
+## Requirements
+To run this tool locally, you need either:
+- **Python 3** (Recommended) or
+- **Node.js** (npm/npx)
+
+Simply run `start.bat` to begin!