Merge pull request #12 from thomasleveil/doc-contents

add tables of contents to most of the README files

CONTRIBUTING.md

@@ -3,6 +3,15 @@
 Great that you are here and you want to contribute to n8n
 
 
+## Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Directory Structure](#directory-structure)
+- [Development Setup](#development-setup)
+- [Development Cycle](#development-cycle)
+- [Create Custom Nodes](#create-custom-nodes)
+
+
 ## Code of Conduct
 
 This project and everyone participating in it are governed by the Code of
@@ -138,3 +147,14 @@ npm run test
 If that gets executed in one of the package folders it will only run the tests
 of this package. If it gets executed in the n8n-root folder it will run all
 tests of all packages.
+
+
+
+## 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.
+
+[To n8n-node-dev](https://github.com/n8n-io/n8n/tree/master/packages/node-dev)
+

README.md

@@ -15,25 +15,16 @@ is there currently not much documentation. That will hopefully change soon.
 
 ## Demo
 
-A short demo (< 3 min) which shows how to create a simple workflow which
+[:tv: A short demo (< 3 min)](https://www.youtube.com/watch?v=ePdcf0yaz1c) 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:
+received or lost a star.
-
-[https://www.youtube.com/watch?v=ePdcf0yaz1c](https://www.youtube.com/watch?v=ePdcf0yaz1c)
 
 
 
 ## Usage
 
-Information about how to install and use it can be found in the cli package [here](https://github.com/n8n-io/n8n/tree/master/packages/cli)
+- :books: Learn [how to **install** and **use** it from the command line](https://github.com/n8n-io/n8n/tree/master/packages/cli/README.md)
-
+- :whale: Learn [how to run n8n in **Docker**](https://github.com/n8n-io/n8n/tree/master/docker/images/n8n/README.md)
-And information about how to run it in Docker [here](https://github.com/n8n-io/n8n/tree/master/docker/images/n8n)
-
-
-
-## Development Setup
-
-A guide how to set everything up can be found in the file [CONTRIBUTING.md](CONTRIBUTING.md)
 
 
 
@@ -67,6 +58,12 @@ did not hear anybody complain there. So I guess it should be ok.
 
 
 
+## Development Setup
+
+Have you found a bug :bug: ? Or maybe you have a nice feature :sparkles: to contribute ? The [CONTRIBUTING guide](CONTRIBUTING.md) will help you get your development environment ready in minutes.
+
+
+
 ## License
 
 [Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md)

docker/images/n8n/README.md

@@ -11,13 +11,24 @@ so also used with internal tools.
 Is still in beta so can not guarantee that everything works perfectly. Also
 is there currently not much documentation. That will hopefully change soon.
 
+
+## Contents
+
+- [Demo](#demo)
+- [Start n8n in Docker](#start-n8n-in-docker)
+- [Start with tunnel](#start-with-tunnel)
+- [Securing n8n](#securing-n8n)
+- [Persist data](#persist-data)
+- [Passing Senstive Data via File](#passing-senstive-data-via-file)
+- [What does n8n mean and how do you pronounce it](#what-does-n8n-mean-and-how-do-you-pronounce-it)
+- [License](#license)
+
+
 ## Demo
 
-A short demo (< 3 min) which shows how to create a simple workflow which
+[:tv: A short demo (< 3 min)](https://www.youtube.com/watch?v=ePdcf0yaz1c) 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:
+received or lost a star.
-
-[https://www.youtube.com/watch?v=ePdcf0yaz1c](https://www.youtube.com/watch?v=ePdcf0yaz1c)
 
 
 

packages/cli/README.md

@@ -11,14 +11,28 @@ so also used with internal tools.
 Is still in beta so can not guarantee that everything works perfectly. Also
 is there currently not much documentation. That will hopefully change soon.
 
+## Contents
+
+<!-- TOC -->
+- [Demo](#demo)
+- [Give n8n a spin](#give-n8n-a-spin)
+- [Installation](#installation)
+- [Start](#start)
+- [Execute Workflow from CLI](#execute-workflow-from-cli)
+- [Create Custom Nodes](#create-custom-nodes)
+- [Keyboard Shortcuts](#keyboard-shortcuts)
+- [Run n8n on own server](#run-n8n-on-own-server)
+- [Hosted n8n](#hosted-n8n)
+- [What does n8n mean and how do you pronounce it](#what-does-n8n-mean-and-how-do-you-pronounce-it)
+- [License](#license)
+- [Development](#development)
+<!-- /TOC -->
 
 ## Demo
 
-A short demo (< 3 min) which shows how to create a simple workflow which
+[:tv: A short demo (< 3 min)](https://www.youtube.com/watch?v=ePdcf0yaz1c) 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:
+received or lost a star.
-
-[https://www.youtube.com/watch?v=ePdcf0yaz1c](https://www.youtube.com/watch?v=ePdcf0yaz1c)
 
 
 ## Give n8n a spin

packages/node-dev/README.md

@@ -9,6 +9,17 @@ to create credentials and nodes in TypeScript for n8n.
 npm install n8n-node-dev -g
 ```
 
+## Contents
+
+- [Usage](#usage)
+- [Commands](#commands)
+- [Create a node](#create-a-node)
+    - [Node Type](#node-type)
+    - [Node Type Description](#node-type-description)
+    - [Node Properties](#node-properties)
+    - [Node Property Options](#node-property-options)
+- [License](#license)
+
 
 ## Usage