mirrors/n8n-nodes-starter
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n-nodes-starter.git synced 2025-10-29 06:22:24 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve README.md

Browse source
This commit is contained in:
Valentina 2022-02-01 14:02:19 +02:00
commit 5ec16f7da2
1 changed files with 14 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -4,30 +4,39 @@
Example starter module for custom n8n nodes. Example starter module for custom n8n nodes.
## Try it out ## Try it out
Clone the repo and execute: [N8N documentation on custom nodes](https://docs.n8n.io/nodes/creating-nodes/create-n8n-nodes-module.html)
Clone the n8n-nodes-starter repository and execute:
``` ```
cd n8n-nodes-starter # Install dependencies
npm install npm install
# Build the code
npm run build npm run build
# "Publish" the package locally
npm link npm link
``` ```
After that add it to an N8N installation: Create an N8N installation and add the n8n-nodes-starter to it:
``` ```
# Create an N8N installation
cd .. cd ..
mkdir n8n_install mkdir n8n_install
cd n8n_install cd n8n_install
npm init npm init
npm install npm install
npm install n8n npm install n8n
# "Install" the locally published module
npm link n8n-nodes-starter npm link n8n-nodes-starter
# Start n8n
npx n8n npx n8n
``` ```
## License ## License
[Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/LICENSE.md) [Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/LICENSE.md)