From 2d291d0fc504b88e0ae9548ae7c0e4e84f041c5f Mon Sep 17 00:00:00 2001
From: mgfxer <173525274+mgfxer@users.noreply.github.com>
Date: Fri, 12 Jul 2024 20:49:03 -0500
Subject: [PATCH] Create README.md

---
 README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..42f37ba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+## Dynamic Animated Weights Helper
+
+### Description
+The Dynamic Animated Weights Helper is a versatile extension for animation workflows, providing various frame and mask sequence manipulation tools. This node facilitates the creation of complex animation effects with ease and flexibility.
+
+### Features
+- Supports multiple animation types including directional transitions, circle growth/shrink, fades, spins, and venetian blinds.
+- Includes options for easing, blur effects, and frame transitions.
+- Allows for generation modes like QR, Edge-FX, and combined outputs.
+- Random animation type selection with options to exclude specific types.
+- Customizable parameters for frame dimensions, transition and hold frames, padding, Gaussian blur, edge effects, and more.
+
+### Input Parameters
+- `animation_type_1` to `animation_type_12`: Select the animation type for each sequence.
+- `transition_easing` and `blur_easing`: Choose the easing function for transitions and blurs.
+- `frame_width` and `frame_height`: Set the dimensions for each frame.
+- `hold_frames`, `transition_frames`, `padding_frames`, and `input_frames`: Configure the number of frames for holding, transitioning, padding, and input sequences.
+- `gaussian_blur_amount`: Adjust the amount of Gaussian blur applied.
+- `edge_fx_thickness`, `push_fx`, `retract_fx`: Parameters for edge effects.
+- `fx_cull_white_frames`: Set the threshold for culling white frames in edge effects.
+- `qr_greyness`: Adjust the greyness for QR generation mode.
+- `random_seed`: Seed for randomization.
+- `edgeFade_contrast` and `edgeFade_blur`: Parameters for edge fade effects.
+- `generation_mode`: Select the generation mode (Only Transitions, Generate QR, Generate Edge-FX, Generate All).
+- `edge_fx_fade_balance`: Balance for edge fade effects.
+- `venetian_bars`: Number of bars for Venetian blinds animation.
+
+### Usage
+This node is designed to be integrated into animation workflows within the ComfyUI environment. The node can generate animations based on various types and apply a range of effects such as transitions, blurs, and edge enhancements.
+
+### Example
+Below is an example of how to use the Dynamic Animated Weights Helper node:
+
+```python
+# Initialize the node
+node = DynamicAnimatedWeightsHelper()
+
+# Define the input parameters
+input_params = {
+    "animation_type_1": "LeftToRight",
+    "animation_type_2": "TopDown",
+    "transition_easing": "ease_in_out",
+    "blur_easing": "false",
+    "frame_width": 512,
+    "frame_height": 512,
+    "hold_frames": 8,
+    "transition_frames": 20,
+    "padding_frames": 6,
+    "input_frames": 5,
+    "gaussian_blur_amount": 1.0,
+    "edge_fx_thickness": 2,
+    "push_fx": 5,
+    "retract_fx": 5,
+    "fx_cull_white_frames": 10.0,
+    "qr_greyness": 0.5,
+    "random_seed": 42,
+    "edgeFade_contrast": 1.5,
+    "edgeFade_blur": 2.0,
+    "generation_mode": "Generate All",
+    "edge_fx_fade_balance": 0.5,
+    "venetian_bars": 4
+}
+
+# Run the node with the input parameters
+outputs = node.run(**input_params)