Skip to content

Commit

Permalink
updated main README
Browse files Browse the repository at this point in the history
  • Loading branch information
telamonian committed Jun 14, 2024
1 parent 01aa195 commit 225fcf7
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## A cookiecutter template for writing a ComfyUI custom node extension

## usage
## Usage

- First install `cookiecutter`:

Expand All @@ -23,3 +23,15 @@
# if you installed cookiecutter with pip
cookiecutter gh:comfy-org/cookiecutter-comfy-extension
```

## Features

The resulting ComfyUI node extension project will automatically come with a few neat features:

- Support for Ruff linter
- A pre-commit hook for the Ruff linter
- An `entry_point` that will ensure that ComfyUI can load your extension regardless of how it's installed

In progress (still needs a little work):
- Testing via PyTest, including a basic integration/sanity check
- A git action that will automatically run any tests as part of Pull Requests made against your project

0 comments on commit 225fcf7

Please sign in to comment.