diff --git a/packages/@n8n/create-node/README.md b/packages/@n8n/create-node/README.md index f2918e668f..9f02fec7cf 100644 --- a/packages/@n8n/create-node/README.md +++ b/packages/@n8n/create-node/README.md @@ -1,13 +1,297 @@ # @n8n/create-node -Scaffold a new community n8n node +A powerful scaffolding tool to quickly create custom n8n community nodes with best practices built-in. -## Usage +## 🚀 Quick Start + +Create a new n8n node in seconds: ```bash -npm create @n8n/node -# or pnpm create @n8n/node -# or -yarn create @n8n/node ``` + +Follow the interactive prompts to configure your node, or specify options directly: + +```bash +pnpm create @n8n/node my-awesome-node --template declarative/custom +``` + +## 📋 Command Line Options + +```bash +pnpm create @n8n/node [NAME] [OPTIONS] +``` + +### Options + +| Flag | Description | +|------|-------------| +| `-f, --force` | Overwrite destination folder if it already exists | +| `--skip-install` | Skip automatic dependency installation | +| `--template