add TOC and version history section

This commit is contained in:
Deborah Barnard 2022-08-17 16:41:50 +01:00
commit 9fbef7d5ad
2 changed files with 19 additions and 0 deletions

View file

@ -12,6 +12,9 @@ trim_trailing_whitespace = true
indent_style = space indent_style = space
indent_size = 2 indent_size = 2
[*.md]
trim_trailing_whitespace = false
[*.yml] [*.yml]
indent_style = space indent_style = space
indent_size = 2 indent_size = 2

View file

@ -6,6 +6,14 @@ _App/service name_ is _one or two sentences describing the service this node int
[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform. [n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
[Installation](#installation)
[Operations](#operations)
[Credentials](#credentials) <!-- delete if no auth needed -->
[Compatibility](#compatibility)
[Usage](#usage) <!-- delete if not using this section -->
[Resources](#resources)
[Version history](#version-history) <!-- delete if not using this section -->
## Installation ## Installation
Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation. Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
@ -18,6 +26,10 @@ _List the operations supported by your node._
_If users need to authenticate with the app/service, provide details here. You should include prerequisites (such as signing up with the service), available authentication methods, and how to set them up._ _If users need to authenticate with the app/service, provide details here. You should include prerequisites (such as signing up with the service), available authentication methods, and how to set them up._
## Compatibility
_State the minimum n8n version, as well as which versions you test against. You can also include any known version incompatibility issues._
## Usage ## Usage
_This is an optional section. Use it to help users with any difficult or confusing aspects of the node._ _This is an optional section. Use it to help users with any difficult or confusing aspects of the node._
@ -29,4 +41,8 @@ _By the time users are looking for community nodes, they probably already know n
* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/) * [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
* _Link to app/service documentation._ * _Link to app/service documentation._
## Version history
_This is another optional section. If your node has multiple versions, include a short description of available versions and what changed, as well as any compatibility impact._