mirrors/n8n-docs
2
0
Fork 0
mirror of https://github.com/n8n-io/n8n-docs.git synced 2025-11-20 17:48:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

✨ Enhance README.md

Browse Source
This commit is contained in:
Tanay Pant 2020-08-31 15:42:30 +02:00
parent 49e302ebb1
commit 2cc8583ff0
1 changed files with 24 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,23 +1,42 @@
# n8n Documentation
# n8n Docs
Repository with the official n8n documentation.
This repository hosts the documentation for n8n, an extendable workflow automation tool which enables you to connect anything to everything via its open, [fair-code](https://faircode.io/) model. The documentation is live at [docs.n8n.io](https://docs.n8n.io/).
## Build Documentation
## Building the documentation
To build the documentation:
```bash
git clone https://github.com/n8n-io/n8n-docs.git
cd n8n-docs
npm install
npm run build
```
## Development
## Contributing
To extend the documentation:
To add to the documentation:
```bash
git clone https://github.com/n8n-io/n8n-docs.git
cd n8n-docs
npm install
npm run dev
```
You can find the contribution guidelines in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
## Support
If you have problems or questions, head to our forum, and we will try to help you as soon as possible:
https://community.n8n.io
## License
n8n-docs 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).