From f06015eedc6f4f03f49600c97ad300391a9b03bc Mon Sep 17 00:00:00 2001
From: Black Lioness <100057094+Black-Lioness@users.noreply.github.com>
Date: Thu, 21 Nov 2024 17:50:57 +0000
Subject: [PATCH] Update README.md

---
 README.md | 113 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 112 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8f43184..21859d7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,112 @@
-# ComfyUI-PromptUtils
\ No newline at end of file
+A set of ComfyUI nodes designed to enhance your workflow with realistic filename generation and keyword generation.
+
+## Filename Generator 📁
+
+Generates realistic filenames and file paths for various digital media formats. Filenames as prompts are not a magic bullet, but I have found that they can produce interesting effects with Flux (add `DSC_0123.JPG` to any prompt and try yourself) This is for the cherry-pickers.
+
+#### Features
+
+- Generates realistic filenames for 28 different devices and platforms
+- Creates authentic file paths in both simple and complex formats
+- Customizable through prompt text and random seed
+
+#### Input Parameters
+
+1. **Prompt**: (Optional) Text that will be incorporated into the file path
+   - Spaces will be converted to underscores
+   - Used to create topic-specific folders
+
+2. **Extra Prompt**: (Optional) Additional text to be used in filename or path generation
+
+3. **Format**: Choose from these categories:
+   - 🎲 Random (randomly selects a format)
+   - 📷 Camera Brands: Nikon, Canon, Fujifilm, Sony, Panasonic, Casio, Generic
+   - 📱 Mobile Devices: Android, iPhone (HEIC/JPEG), Pixel, Samsung
+   - 🖥️ Screenshots: Windows, macOS
+   - 🎥 Video/Social: VLC, WhatsApp, Instagram, Facebook, Snapchat, TikTok
+   - 🚁 Drones: DJI, Mavic
+   - 📹 Action/Security: GoPro, Dashcam, Security Camera, CCTV
+   - 🤿 Specialty: Underwater, Aerial
+   - 🖼️ Special: 3D Scan, Thermal Imaging and more
+
+4. **Path**: Choose between:
+   - Disabled: No path
+   - Simple: Basic directory structures
+   - Complex: More detailed folder hierarchies including common user directories
+
+5. **Seed**: (Optional)
+
+#### Outputs
+
+1. **Filename Only**: Just the generated filename (e.g., `IMG_0123.CR3`)
+2. **Filename With Path**: Complete file path (e.g., `C:\Users\Photos\IMG_0123.CR3`)
+
+#### Example Usages
+
+##### Camera Photo
+```
+Prompt: Big fat Steve Mt Everest trip
+Format: 📷 Nikon
+Path: Simple
+```
+Possible output:
+- Filename Only: `DSC_0123.JPG`
+- Filename With Path: `C:\Big_fat_Steve_Mt_Everest_trip\DSC_0123.JPG`
+
+##### Social Media Content
+```
+Prompt: Crazy New Years Eve drunk party 1999
+Format: 📸 Instagram
+Path: Complex
+```
+Possible output:
+- Filename Only: `insta4567.jpg`
+- Filename With Path: `D:\Users\Pictures\Crazy_New_Years_Eve_drunk_party_1999\insta4567.jpg`
+
+##### Thermal Imaging
+```
+Prompt: Beautiful France Provence countryside
+Format: 🌡️ Thermal Imaging
+Path: Complex
+```
+Possible output:
+- Filename Only: `InfraredImage_45678_20240117_143022.jpg`
+- Filename With Path: `E:\Projects\Beautiful_France_Provence_countryside\InfraredImage_45678_20240117_143022.jpg`
+
+---
+
+## Keyword Generator 🔑
+
+Generates random keywords to enhance your prompts. Generated by multiple publicly available LLMs with this prompt:
+```
+Generate a python list of descriptive phrases capturing the essence of natural, candid, or imperfect visual visual aesthetics. Focus on terms explicitly associated with unedited, spontaneous photography, or film-like qualities. Include descriptions of lighting, textures, compositions, and moods. Aim for short terms that evoke realism, rawness, and unposed beauty, while incorporating subtle artistic imperfections.
+```
+
+#### Features
+
+- Generates a specified number of random keywords while incorporating existing prompts
+- Supports consistent keyword generation through seed
+
+#### Input Parameters
+
+1. **Prompt**: (Optional) 
+   - Base text to prepend to generated keywords
+2. **Keywords Count**: 
+   - Range: 1-50 keywords, default: 1 keyword
+3. **Seed**: (Optional)
+#### Output
+
+- **Keyword(s)**: A comma-separated list of generated keywords
+
+#### Basic Keyword Generation
+```
+Keywords Count: 3
+```
+Possible output: `candid, amateur photo, 35mm`
+
+#### Prompt-Based Keyword Generation
+```
+Prompt: Landscape photography
+Keywords Count: 2
+```
+Possible output: `Landscape photography candid, wide angle`