From c066b8081e672b905e9fe0e427ba78f2abb31af0 Mon Sep 17 00:00:00 2001 From: Tanay Pant <7481165+tanay1337@users.noreply.github.com> Date: Tue, 1 Sep 2020 14:41:29 +0200 Subject: [PATCH] :books: Update copy and add information (#910) * Update README.md * Update README.md * Update CONTRIBUTING.md --- CONTRIBUTING.md | 22 +++++----------------- README.md | 17 ++++++++--------- 2 files changed, 13 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fcc046beef..7fa19c8cbd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -119,6 +119,10 @@ To start n8n execute: npm run start ``` +To start n8n with tunnel: +``` +./packages/cli/bin/n8n start --tunnel +``` ## Development Cycle @@ -213,23 +217,7 @@ If you'd like to submit a new node, please go through the following checklist. T ## Extend Documentation -All the files which get used in the n8n documentation on [https://docs.n8n.io](https://docs.n8n.io) -can be found in the [/docs](https://github.com/n8n-io/n8n/tree/master/docs) folder. So all changes -and additions can directly be made in there - -That the markdown docs look pretty we use [docsify](https://docsify.js.org). It is possible to test -locally how it looks like rendered with the following commands: - -```bash -# 1. Install docisify -npm i docsify-cli -g - -# 2. Go into n8n folder (the same folder which contains this file). For example: -cd /data/n8n - -# 3. Start docsificy -docsify serve ./docs -``` +The repository for the n8n documentation on https://docs.n8n.io can be found [here](https://github.com/n8n-io/n8n-docs). ## Contributor License Agreement diff --git a/README.md b/README.md index 0150479ff0..9287a865ed 100644 --- a/README.md +++ b/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) licensed node based Workflow Automation Tool. It can be self-hosted, easily extended, and so also used with internal tools. +n8n is an extendable workflow automation tool. With a [fair-code](http://faircode.io) distribution model, n8n will always have visible source code, be available to self-host, and allow you to add your own custom functions, logic and apps. n8n's node-based approach makes it highly versatile, enabling you to connect anything to everything. n8n.io - Screenshot @@ -16,7 +16,7 @@ received or lost a star. ## Available integrations -n8n has 100+ different nodes to automate workflows. The list can be found on: [https://n8n.io/nodes](https://n8n.io/nodes) +n8n has 170+ different nodes to automate workflows. The list can be found on: [https://n8n.io/nodes](https://n8n.io/nodes) ## Documentation @@ -67,16 +67,15 @@ check out our job posts: **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) +**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. +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. +'n8n'." - **Jan Oberhauser, Founder and CEO, n8n.io** @@ -88,6 +87,6 @@ Have you found a bug :bug: ? Or maybe you have a nice feature :sparkles: to cont ## License -n8n is [fair-code](http://faircode.io) licensed under [**Apache 2.0 with Commons Clause**](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md) +n8n is [fair-code](http://faircode.io) licensed under [**Apache 2.0 with Commons Clause**](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md). -Additional information about license can be found in the [FAQ](https://docs.n8n.io/#/faq?id=license) +Additional information about license can be found in the [FAQ](https://docs.n8n.io/#/faq?id=license).