From 6954c551119e1457a303262471a226cb275509eb Mon Sep 17 00:00:00 2001
From: hnmr293 <hnmr293@gmail.com>
Date: Thu, 30 Mar 2023 02:34:50 +0900
Subject: [PATCH] add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f419a68
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# ComfyUI custom nodes
+
+## Basic nodes
+
+|category|node name|input type|output type|desc.|
+| --- | --- | --- | --- | --- |
+|value|Text|`STRING`|`TEXT`| - |
+|value|Integer|`INT`|`Integer`| - |
+|value|Float|`FLOAT`|`Float`| - |
+|value|SamplerName|(dropdown)|`SamplerName`| - |
+|value|SchedulerName|(dropdown)|`SchedulerName`| - |
+
+## CLIP nodes
+
+|category|node name|input type|output type|desc.|
+| --- | --- | --- | --- | --- |
+|conditioning|CLIPTextEncode2|`CLIP`, `TEXT`|`CONDITIONING`|external prompt input|
+
+## Latent nodes
+
+|category|node name|input type|output type|desc.|
+| --- | --- | --- | --- | --- |
+|latent|RandomLatentImage|`INT`, `INT`, `INT`|`LATENT`|(width, height, batch_size)|
+|latent|VAEDecodeBatched|`LATENT`, `VAE`, `INT`|`IMAGE`|VAE decoding with specified batch size|
+|latent|VAEEncodeBatched|`IMAGE`, `VAE`, `INT`|`LATENT`|VAE encoding with specified batch size|
+
+## Sampling nodes
+
+|category|node name|input type|output type|desc.|
+| --- | --- | --- | --- | --- |
+|sampling|KSamplerSetting|`MODEL`, `CONDITIONING`, `CONDITIONING`, `LATENT`|`DICT`|aggregate sampler's setting to dict|
+|sampling|KSamplerOverrided|various|`LATENT`|override sampler's setting defined by `KSamplerSetting`|
+|sampling|KSamplerXYZ|various|`LATENT`|generate latents with values|
+
+## Model nodes and Loader nodes
+
+|category|node name|input type|output type|desc.|
+| --- | --- | --- | --- | --- |
+|loader|StateDictLoader|(model name)|`DICT`|aggregate sampler's setting to dict|
+|model|Dict2Model|`DICT`, (config_file)|`MODEL`|instantiate a model from given dict|
+|model|StateDictMerger|`DICT`, `DICT`, `FLOAT`|`MODEL`, `CLIP`, `VAE`|merge two or three models|
+|model|StateDictMergerBlockWeighted|`DICT`, `DICT`|`DICT`|merge two models with per-block weights|
+
+## Output nodes
+
+|category|node name|input type|output type|desc.|
+| --- | --- | --- | --- | --- |
+|image|GridImage|||generate single image with specific columns|