From 35d7b9b3ebd1df6a3b238bd72411e7c2bd18993a Mon Sep 17 00:00:00 2001 From: Deborah Barnard Date: Thu, 11 Aug 2022 10:35:49 +0100 Subject: [PATCH] add test step --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4e1cad9..c9b759c 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,8 @@ # n8n-nodes-starter - This repo contains example nodes to help you get started building your own custom integrations for [n8n](n8n.io). It includes the node linter and other dependencies. - 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). ## Prerequisites @@ -21,10 +19,8 @@ You need the following installed on your development machine: * Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/). - ## Using this starter - These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the [documentation](https://docs.n8n.io/integrations/creating-nodes/). 1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template repository. @@ -37,7 +33,8 @@ These are the basic steps for working with the starter. For detailed guidance on 5. Browse the examples in `/nodes` and `/credentials`. Modify the examples, or replace them with your own nodes. 6. Update the `package.json` to match your details. 7. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible. -8. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm. +8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance. +9. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm. ## More information