From b9fa372d940643c5079d5c165bb0eee19aa98bf5 Mon Sep 17 00:00:00 2001 From: Deborah Barnard Date: Mon, 13 Jun 2022 16:46:20 +0100 Subject: [PATCH 1/2] quick update --- README.md | 15 +++++++++++++-- package.json | 3 ++- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6148a6d..fae77bc 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ # n8n-nodes-starter -![n8n.io - Workflow Automation](https://raw.githubusercontent.com/n8n-io/n8n/master/docs/images/n8n-logo.png) +This repo contains example nodes to help you get starting building your own custom integrations for n8n. -Example starter module for custom n8n nodes. +## Using this starter +1. Clone the repo: + ``` + git clone https://github.com/n8n-io/n8n-nodes-starter.git + ``` +2. Open the project in your editor. +3. Browse the examples in `/nodes`. Modify the examples, or replace them with your own nodes. +4. Update the `package.json` to match your details. + +## More information + +Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes. ## License diff --git a/package.json b/package.json index 5fe4f72..baea4d0 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,8 @@ { - "name": "n8n-nodes-starter", + "name": "n8n-node-starter", "version": "0.1.0", "description": "Example starter module for custom n8n nodes.", + "keywords": ["n8n-community-node-package"], "license": "SEE LICENSE IN LICENSE.md", "homepage": "https://n8n.io", "author": { From c20c6995eaa698f52f3743980b811a18104beb61 Mon Sep 17 00:00:00 2001 From: Deborah Barnard Date: Mon, 13 Jun 2022 16:50:13 +0100 Subject: [PATCH 2/2] add a bit more detail to readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index fae77bc..83e0f39 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ This repo contains example nodes to help you get starting building your own custom integrations for n8n. +All nodes are npm packages. To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry). + ## Using this starter 1. Clone the repo: