From 82978f7531bef287f29af690b0e6912949df6393 Mon Sep 17 00:00:00 2001 From: BRADSEC Date: Sat, 25 Jan 2025 19:24:58 +1000 Subject: [PATCH] Update README --- README.md | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 6a189b3..b7ce7ca 100644 --- a/README.md +++ b/README.md @@ -9,42 +9,41 @@ Custom nodes for ComfyUI that provide text/string manipulation capabilities. Par - Whole string matching option ## String Strip Node -Removes specified strings from input text. Each line should contain the string to be searched. The string can contain multiple words. To match individual words/strings place on seperate lines. -![stringstrip](stringstrip.png) +Removes specified strings from input text. Each line should contain the string to be searched. The string can contain multiple words. To match individual words/strings place on separate lines. +![stringstrip](stringstrip.png) ### Inputs - **`input_string`**: The string or text to process - **`strings_to_remove`**: List of strings to remove (one per line) -- **`match_case`**: Enable/disable case-sensitive matching -- **`match_whole_string`**: Ensure only exact matches are removed -- **`remove_extra_spaces`**: Clean up extra spaces after removal - -### String Strip Example Usage: +- **`match_case`**: Enable/disable case-sensitive matching (default: disabled) +- **`match_whole_string`**: Ensure only exact matches are removed (default: enabled) +- **`remove_extra_spaces`**: Clean up extra spaces after removal (default: enabled) + +### String Strip Example Usage: ![examplestrip](examplestrip.png) ## String Replace Node -Replaces text strings with new strings. Each line should contain a search and replace pair separated replace_delimiter. See example image below. +Replaces text strings with new strings. Each line should contain a search and replace pair separated by the replacement_delimiter (default is double colon `::`). + ![stringreplace](stringreplace.png) ### Inputs - **`input_string`**: The string or text to process -- **`replacement_pairs`**: List of search:replace pairs (one per line) -- **`replacement_delimiter`**: Character(s) that separate search and replace strings. Default is a double colon `::` -- **`match_case`**: Enable/disable case-sensitive matching -- **`match_whole_string`**: Ensure only exact matches are replaced -- **`remove_extra_spaces`**: Clean up extra spaces after replacement +- **`replacement_pairs`**: List of search::replace pairs (one per line) +- **`replacement_delimiter`**: Character(s) that separate search and replace strings (default: `::`) +- **`match_case`**: Enable/disable case-sensitive matching (default: disabled) +- **`match_whole_string`**: Ensure only exact matches are replaced (default: disabled) +- **`remove_extra_spaces`**: Clean up extra spaces after replacement (default: enabled) -### String Replace Example Usage: +### String Replace Example Usage: ![examplereplace](examplereplace.png) ## Installation - 1. Navigate to the `custom_nodes` directory in your ComfyUI installation path. 2. Clone the repository: - ```bash - git clone https://github.com/bradsec/ComfyUI_StringEssentials.git - ``` +```bash +git clone https://github.com/bradsec/ComfyUI_StringEssentials.git +``` 3. Restart ComfyUI or refresh your nodes. - -4. Select node from the `utils` menu. `Add Node > utils >` `String Strip` or `String Replace` +4. Select node from the utils menu. `Add Node > utils >` `String Strip` or `String Replace` \ No newline at end of file