From ff9cd121630b568eb8bfd6ee4a982dfd27491175 Mon Sep 17 00:00:00 2001
From: cavinHuang <huangchunmao1993@gmail.com>
Date: Fri, 17 May 2024 18:09:58 +0800
Subject: [PATCH] =?UTF-8?q?feat:=20=E5=A2=9E=E5=8A=A0=E6=96=87=E6=A1=A3?=
 =?UTF-8?q?=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index c086762..90448e2 100644
--- a/README.md
+++ b/README.md
@@ -11,3 +11,39 @@ This is the documentation for the comfyUI every nodes.
 - Restart ComfyUI
 
 ## development
+
+### fork the repo
+
+- Fork the repo to your own github account
+- Create a new branch for your changes and make the changes
+- Create a pull request to the main repo
+
+### add a new node docs
+
+- Create a Markdown file named after the `node type` in the 'docs' folder, such as `CLIPMergeSimple.md`
+- Add the following structure to the file, please refer to specific examples(CLIPMergeSimple.md)[docs/CLIPMergeSimple.md] for details.:
+
+<pre><code>
+# Documentation
+- Class name: Node name
+- Category: Node category
+- Output node: False
+- Repo Ref: https://github.com/xxxx
+
+Description of nodes
+
+# Input types
+
+Node input types
+
+# Output types
+
+Node output types
+
+# Usage tips
+- Infra type: GPU
+
+# Source code
+
+Node source code
+</code></pre>
\ No newline at end of file