From 2c2cfec619ee838d4693146eae008c2cd9bf5625 Mon Sep 17 00:00:00 2001 From: SEKiN <112916323+SEkINVR@users.noreply.github.com> Date: Sat, 6 Jul 2024 22:03:10 -0700 Subject: [PATCH] Update README.md Signed-off-by: SEKiN <112916323+SEkINVR@users.noreply.github.com> --- README.md | 80 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 48 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index e57f2d9..d05328a 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,77 @@ # ComfyUI-SaveAs - -A custom node for ComfyUI that allows saving images and videos in multiple formats with a preview feature. +A custom node for ComfyUI that allows saving images in multiple formats with advanced options and a preview feature. ## Supported Formats - - Images: PNG, JPG, WEBP, ICO, GIF, BMP, TIFF -- Videos: MP4, MOV -- Others: SVG, PDF, PSD, RAW -- + ## Features -- Supports PNG, JPG, WEBP, ICO, GIF, BMP, and TIFF formats -- ICO size presets +- High-quality saving for all supported formats +- Customizable quality settings for applicable formats +- ICO size presets (Small, Medium, Large) - Preview of saved image and filenames -- Customize quality for supported formats +- Automatic file naming to prevent overwrites ## Installation - 1. Clone this repository into your ComfyUI's `custom_nodes` directory: -```bash - git clone https://github.com/SEkINVR/ComfyUI-SaveAs.git -``` -2. Install the required dependencies: -```bash - pip install -r requirements.txt -``` + ```bash + git clone https://github.com/SEkINVR/ComfyUI-SaveAs.git + ``` +2. Navigate to the ComfyUI-SaveAs directory: + ```bash + cd ComfyUI-SaveAs + ``` +3. Run the installation script: + ```bash + ./install_requirements.sh + ``` ## Requirements +This custom node requires the following Python package: +- Pillow >= 9.5.0 -This custom node requires the following Python packages: -- Pillow >= 9.0.0 -- numpy >= 1.20.0 +This is usually already installed with ComfyUI, but the installation script will ensure you have the correct version. ## Usage - 1. In ComfyUI, you'll find a new node called "Save As" under the "image/io" category. 2. Connect an image output to this node. -3. Choose your desired format and settings. +3. Choose your desired format, quality, and ICO size preset (if applicable). 4. Run the workflow to save your image and generate a preview. +## Updating +To update the node to the latest version: -These are usually already installed with ComfyUI, but if you encounter any issues, you can install them manually: -```bash -pip install -r requirements.txt -git add .gitignore requirements.txt -git commit -m "Add requirements.txt and .gitignore" -git push -``` -Node> +1. Navigate to your ComfyUI root directory. +2. Run the following command: + ```bash + ./custom_nodes/ComfyUI-SaveAs/update.sh + ``` + +## Repository Structure ``` ComfyUI-SaveAs/ │ ├── __init__.py ├── ComfyUISaveAs.py ├── README.md -├── requirements.txt (if needed) -├── install.sh +├── requirements.txt +├── install_requirements.sh ├── update.sh └── examples/ (optional) └── example_workflow.png ``` + +## Contributing +Contributions are welcome! Please feel free to submit a Pull Request. + +## License +[MIT License](https://opensource.org/licenses/MIT) +``` + +This updated README reflects the current state of your project, including: + +1. The accurate list of supported image formats. +2. Updated features, including high-quality saving and preview capabilities. +3. Correct installation instructions using the `install_requirements.sh` script. +4. Updated requirements, specifying Pillow >= 9.5.0. +5. Instructions for updating the node using the `update.sh` script. +6. An accurate repository structure.