Skip to content

Commit

Permalink
Add comfy_types to README as well.
Browse files Browse the repository at this point in the history
  • Loading branch information
robinjhuang committed Dec 30, 2024
1 parent 94dac21 commit 83bc0ef
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions {{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## {{cookiecutter.project_short_description}}

Get started writing custom nodes without worrying about python project setup.

## Install

[Install](https://docs.comfy.org/get_started) ComfyUI first. Then look up this extension in [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager). If you are installing manually, clone this repository under `ComfyUI/custom_nodes`.
Expand Down Expand Up @@ -31,6 +33,9 @@ git commit -m "project scaffolding"
git push
```

## comfy_types
ComfyUI exposes types that are very helpful when developing custom nodes.

## Publishing to Registry

If you wish to share this custom node with others in the community, you can publish it to the registry. We've already auto-populated some fields in `pyproject.toml` under `tool.comfy`, but please double-check if they are correct.
Expand Down

0 comments on commit 83bc0ef

Please sign in to comment.