From 1888f5c4a54af25fb95cf6d63a6251b88b01ee90 Mon Sep 17 00:00:00 2001 From: Harshil Agrawal Date: Wed, 12 May 2021 21:52:31 +0200 Subject: [PATCH] :books: Update documentation for npm package (#1770) --- packages/cli/README.md | 143 +++++++++++++++++++++++++++-------------- 1 file changed, 95 insertions(+), 48 deletions(-) diff --git a/packages/cli/README.md b/packages/cli/README.md index 61da7bcf35..d7aad52434 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -2,7 +2,7 @@ ![n8n.io - Workflow Automation](https://raw.githubusercontent.com/n8n-io/n8n/master/assets/n8n-logo.png) -n8n is a free and open [fair-code](http://faircode.io) distributed node based Workflow Automation Tool. It can be self-hosted, easily extended, and so also used with internal tools. +n8n is a free and open [fair-code](http://faircode.io) distributed node-based Workflow Automation Tool. You can self-host n8n, easily extend it, and even use it with internal tools. n8n.io - Screenshot @@ -11,98 +11,145 @@ n8n is a free and open [fair-code](http://faircode.io) distributed node based Wo - [Demo](#demo) +- [Getting Started](#getting-started) + - [Use npx](#use-npx) + - [Run with Docker](#run-with-docker) + - [Install with npm](#install-with-npm) + - [Sign-up on n8n.cloud](#sign-up-on-n8n.cloud) - [Available integrations](#available-integrations) - [Documentation](#documentation) - [Create Custom Nodes](#create-custom-nodes) -- [Hosted n8n](#hosted-n8n) +- [Contributing](#contributing) - [What does n8n mean and how do you pronounce it](#what-does-n8n-mean-and-how-do-you-pronounce-it) - [Support](#support) - [Jobs](#jobs) - [Upgrading](#upgrading) - [License](#license) -- [Development](#development) ## Demo -[:tv: A short demo (< 3 min)](https://www.youtube.com/watch?v=3w7xIMKLVAg) -which shows how to create a simple workflow which automatically sends a new -Slack notification every time a Github repository received or lost a star. +📺 Here's a [short demo (<3 min)](https://www.youtube.com/watch?v=3w7xIMKLVAg) that shows how to create a simple workflow to automatically sends a notification on Slack every time a GitHub repository gets starred or un-starred. +## Getting Started + +There are a couple of ways to get started with n8n. + +### Use npx + +To spin up n8n using npx, you can run: + +```bash +npx n8n +``` + +It will download everything that is needed to start n8n. + +You can then access n8n by opening: +[http://localhost:5678](http://localhost:5678) + +**Note:** The minimum required version for Node.js is v14.15. Make sure to update Node.js to v14.15 or above. + +### Run with Docker + +To play around with n8n, you can also start it using Docker: + +```bash +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + n8nio/n8n +``` + +Be aware that all the data will be lost once the Docker container gets removed. To persist the data mount the `~/.n8n` folder: + +```bash +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + -v ~/.n8n:/home/node/.n8n \ + n8nio/n8n +``` + +n8n also offers a Docker image for Raspberry Pi: `n8nio/n8n:latest-rpi`. + +Refer to the [documentation](https://github.com/n8n-io/n8n/blob/master/docker/images/n8n/README.md) for more information on the Docker setup. + +### Install with npm + +To install n8n globally using npm: + +```bash +npm install n8n -g +``` + +After the installation, start n8n running the following command: + +```bash +n8n +# or +n8n start +``` + +### Sign-up on n8n.cloud + +Sign-up for an [n8n.cloud](https://www.n8n.cloud/) account. + +While n8n.cloud and n8n are the same in terms of features, n8n.cloud provides certain conveniences such as: +- Not having to set up and maintain your n8n instance +- Managed OAuth for authentication +- Easily upgrading to the newer n8n versions ## Available integrations -n8n has 200+ different nodes to automate workflows. The list can be found on: [https://n8n.io/nodes](https://n8n.io/nodes) - +n8n has 280+ different nodes that allow you to connect various services and build your automation workflows. You can find the list of all the integrations at [https://n8n.io/integrations](https://n8n.io/integrations) ## Documentation -The official n8n documentation can be found under: [https://docs.n8n.io](https://docs.n8n.io) +To learn more about n8n, refer to the official documentation here: [https://docs.n8n.io](https://docs.n8n.io) -Additional information and example workflows on the n8n.io website: [https://n8n.io](https://n8n.io) +You can find additional information and example workflows on the [n8n.io](https://n8n.io) website. ## Create Custom Nodes -It is very easy to create own nodes for n8n. More information about that can -be found in the documentation of "n8n-node-dev" which is a small CLI which -helps with n8n-node-development. +You can create custom nodes for n8n. Follow the instructions mentioned in the documentation to create your node: [Creating nodes](https://docs.n8n.io/nodes/creating-nodes/create-node.html) -[To n8n-node-dev](https://github.com/n8n-io/n8n/tree/master/packages/node-dev) +## Contributing -Additional information can be found on the [ documentation page](https://docs.n8n.io/#/create-node). +🐛 Did you find a bug? +✨ Do you want to contribute a feature? -## Hosted n8n +The [CONTRIBUTING guide](https://github.com/n8n-io/n8n/blob/master/CONTRIBUTING.md) will help you set up your development environment. -If you are interested in a hosted version of n8n on our infrastructure please contact us via: -[hosting@n8n.io](mailto:hosting@n8n.io) +You can find more information on how you can contribute to the project on our documentation: [How can I contribute?](https://docs.n8n.io/reference/contributing.html) +## What does n8n mean, and how do you pronounce it? +**Short answer:** n8n is an abbreviation for "nodemation", and it is pronounced as n-eight-n. -## What does n8n mean and how do you pronounce it? - -**Short answer:** It means "nodemation" and it is pronounced as n-eight-n. - -**Long answer:** I get that question quite often (more often than I expected) -so I decided it is probably best to answer it here. While looking for a -good name for the project with a free domain I realized very quickly that all the -good ones I could think of were already taken. So, in the end, I chose -nodemation. "node-" in the sense that it uses a Node-View and that it uses -Node.js and "-mation" for "automation" which is what the project is supposed to help with. -However, I did not like how long the name was and I could not imagine writing -something that long every time in the CLI. That is when I then ended up on -"n8n". Sure does not work perfectly but does neither for Kubernetes (k8s) and -did not hear anybody complain there. So I guess it should be ok. +**Long answer:** In n8n, you build your automation ("-mation") workflows by connecting different nodes in the Editor UI. The project is also built using Node.js. As a consequence, the project was named nodemation. +However, the name was long, and it wouldn't be a good idea to use such a long name in the CLI. Hence, nodemation got abbreviated as "n8n" (there are eight characters between the first and the last n!). ## Support -If you have problems or questions go to our forum, we will then try to help you asap: - -[https://community.n8n.io](https://community.n8n.io) - - +If you run into issues or have any questions reach out to us via our community forum: [https://community.n8n.io](https://community.n8n.io). ## Jobs -If you are interested in working for n8n and so shape the future of the project -check out our [job posts](https://apply.workable.com/n8n/) +If you are interested in working at n8n and building the project, check out the [job openings](https://apply.workable.com/n8n/). ## Upgrading -Before you upgrade to the latest version make sure to check here if there are any breaking changes which concern you: -[Breaking Changes](https://github.com/n8n-io/n8n/blob/master/packages/cli/BREAKING-CHANGES.md) +Before you upgrade to the latest version, make sure to check the changelogs: [Changelog](https://docs.n8n.io/reference/changelog.html) +You can also find breaking changes here: [Breaking Changes](./BREAKING-CHANGES.md) ## License -n8n is [fair-code](http://faircode.io) distributed under [**Apache 2.0 with Commons Clause**](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md) license +n8n is [fair-code](http://faircode.io) distributed under [**Apache 2.0 with Commons Clause**](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md) license. -Additional information about license can be found in the [FAQ](https://docs.n8n.io/#/faq?id=license) - - -## Development - -Have you found a bug :bug: ? Or maybe you have a nice feature :sparkles: to contribute ? The [CONTRIBUTING guide](https://github.com/n8n-io/n8n/blob/master/CONTRIBUTING.md) will help you get your development environment ready in minutes. +Additional information on the license can be found in the [FAQ](https://docs.n8n.io/reference/faq.html#license)