Update README.md

2023-09-28 00:09:58 +08:00
parent 12ee1b7e40
commit 97bb1e7f61
6 changed files with 1301 additions and 6 deletions
@@ -22,7 +22,7 @@ additional metadata to ensure compatibility with metadata detection on websites
    <a href="#usage">Usage</a> •
    <a href="#credits">Credits</a>
  </p>
-    <img src="images/screenshot_v100b1.png">
+    <img src="./images/screenshot_v100b1.png">
 </div>


@@ -43,8 +43,7 @@ See [SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reade

 ## Installation
 ### Install via [ComfyUI Manager](https://github.com/ltdrdata/ComfyUI-Manager) (Recommended)
-~~Search for `SD Prompt Reader` in the ComfyUI Manager and install it.~~
-Waiting for approval.
+Search for `SD Prompt Reader` in the ComfyUI Manager and install it.
 ### Install manually
 1. `cd` to the `custom_node` folder
 2. Clone this repo
@@ -63,8 +62,39 @@ git pull --recurse-submodules
 ```

 ## Usage
-Example workflow coming soon.
+### Prompt Reader Node
+- The Prompt Reader Node works exactly the same as the 
+[standalone SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reader). 
+It uses the Image Data Reader from the 
+[standalone SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reader), 
+allowing it to support the same formats and receive updates along with the 
+[SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reader).   
+
+***For images generated by SDXL and containing multiple sets of prompts, 
+the text_g will be combined with text_l into a single prompt***
+
+<img src="./images/reader.png" width="20%" height="20%" alt="reader node">
+
+### Prompt Saver Node & Parameter Generator Node & Prompt Merger Node
+- The Prompt Saver Node and The Parameter Generator Node are designed to be used together.  
+- The Prompt Saver Node will write additional metadata in the A1111 format to the output images 
+to be compatible with any tools that support the A1111 format, 
+including SD Prompt Reader and Civitai. 
+Due to custom nodes and complex workflows potentially causing issues with SD Prompt Reader's ability 
+to read image metadata correctly, it is recommended to embed this node within the workflow 
+to ensure maximum compatibility.   
+- Since it's not possible to directly extract metadata from KSampler, it is necessary to 
+use the Parameter Generator Node to generate parameters and simultaneously output them to both 
+the Prompt Saver Node and KSampler.
+- Since the A1111 format cannot store text_g and text_l separately, SDXL users need to use the Prompt Merger Node to 
+combine text_g and text_l into a single prompt.
+
+<img src="./images/generator_saver_merger.png" width="20%" height="20%" alt="generator, saver and merger node">
+
+### [Example Workflow](./workflows/example_workflow.json)
+
+<img src="./images/example_workflow.png" width="50%" height="50%" alt="example workflow">

 ## Credits
- The SD Prompt Reader node is based on [ComfyUI_Load_Image_With_Metadata](https://github.com/tkoenig89/ComfyUI_Load_Image_With_Metadata)
- The SD Prompt Saver node is based on [comfy-image-saver](https://github.com/giriss/comfy-image-saver) & [stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui)
+- The SD Prompt Reader node is based on [ComfyUI Load Image With Metadata](https://github.com/tkoenig89/ComfyUI_Load_Image_With_Metadata)
+- The SD Prompt Saver node is based on [Comfy Image Saver](https://github.com/giriss/comfy-image-saver) & [Stable Diffusion Webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui)