mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-12-25 20:54:07 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve documentation

Browse source
This commit is contained in:
Jan Oberhauser 2019-06-24 13:21:07 +02:00
parent 2175477b8e
commit cc405f0c1a
6 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -2,7 +2,7 @@
![n8n.io - Workflow Automation](https://n8n.io/n8n-logo.png) ![n8n.io - Workflow Automation](https://n8n.io/n8n-logo.png)
n8n is a tool which allows to easily and fast automate different taks. n8n is a tool which allows to easily and fast automate different tasks.
<a href="https://n8n.io/n8n-screenshot.png"><img src="https://n8n.io/n8n-screenshot.png" width="550" alt="n8n.io - Screenshot"></a> <a href="https://n8n.io/n8n-screenshot.png"><img src="https://n8n.io/n8n-screenshot.png" width="550" alt="n8n.io - Screenshot"></a>
@ -12,9 +12,9 @@ is there currently not much documentation. That will hopefully change soon.
## Usage ## Usage
Information about how to install and use it can be found in the cli package [here](packages/cli/README.md) 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)
And information about how to run it in Docker [here](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 ## Development Setup
@ -32,4 +32,4 @@ Execute: `npm run start`
## License ## License
[Apache 2.0 with Commons Clause](LICENSE.md) [Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md)

6
packages/cli/README.md
View file

@ -2,7 +2,7 @@
![n8n.io - Workflow Automation](https://n8n.io/n8n-logo.png) ![n8n.io - Workflow Automation](https://n8n.io/n8n-logo.png)
n8n is a tool which allows to easily and fast automate different taks. n8n is a tool which allows to easily and fast automate different tasks.
<a href="https://n8n.io/n8n-screenshot.png"><img src="https://n8n.io/n8n-screenshot.png" width="550" alt="n8n.io - Screenshot"></a> <a href="https://n8n.io/n8n-screenshot.png"><img src="https://n8n.io/n8n-screenshot.png" width="550" alt="n8n.io - Screenshot"></a>
@ -69,7 +69,7 @@ n8n start \
``` ```
Or you can provide a custom configuration file by copying the default Or you can provide a custom configuration file by copying the default
configuration file [(config/defaults.ts)](config/default.ts) and then set the configuration file [(config/defaults.ts)](https://github.com/n8n-io/n8n/blob/master/packages/cli/config/default.ts) and then set the
path to it as environment variable `NODE_CONFIG_DIR`. path to it as environment variable `NODE_CONFIG_DIR`.
For example like this: For example like this:
@ -104,7 +104,7 @@ n8n execute --file <WORKFLOW_FILE>
## License ## License
[Apache 2.0 with Commons Clause](LICENSE.md) [Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md)
## Development ## Development

2
packages/editor-ui/README.md
View file

@ -49,4 +49,4 @@ See [Configuration Reference](https://cli.vuejs.org/config/).
## License ## License
[Apache 2.0 with Commons Clause](LICENSE.md) [Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/editor-ui/LICENSE.md)

2
packages/node-dev/README.md
View file

@ -38,4 +38,4 @@ Creates new basic credentials or node of the selected type to have a first start
## License ## License
[Apache 2.0 with Commons Clause](LICENSE.md) [Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/node-dev/LICENSE.md)

2
packages/nodes-base/README.md
View file

@ -11,4 +11,4 @@ npm install n8n-nodes-base -g
## License ## License
[Apache 2.0 with Commons Clause](LICENSE.md) [Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/LICENSE.md)

2
packages/workflow/README.md
View file

@ -10,4 +10,4 @@ npm install n8n-workflow
## License ## License
[Apache 2.0 with Commons Clause](LICENSE.md) [Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/workflow/LICENSE.md)