From 6491e00373f1ecfb0acd40ab2adb5da499a73152 Mon Sep 17 00:00:00 2001 From: Jonathan Bennetts Date: Mon, 12 May 2025 13:48:19 +0100 Subject: [PATCH] Update readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 622767b..f4d4601 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,10 @@ To make your custom node available to the community, you must create it as an np You need the following installed on your development machine: * [git](https://git-scm.com/downloads) -* Node.js and pnpm. Minimum version Node 18. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows). +* Node.js and pnpm. Minimum version Node 20. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows). * Install n8n with: ``` - pnpm install n8n -g + npm install n8n -g ``` * Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/). @@ -27,11 +27,11 @@ These are the basic steps for working with the starter. For detailed guidance on ``` git clone https://github.com//.git ``` -3. Run `pnpm i` to install dependencies. +3. Run `npm i` to install dependencies. 4. Open the project in your editor. 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 `pnpm lint` to check for errors or `pnpm lintfix` to automatically fix errors when possible. +7. Run `npm lint` to check for errors or `npm lintfix` to automatically fix errors when possible. 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. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started. 10. Update the LICENSE file to use your details.