Skip to content

Commit 9fbef7d

Browse files
author
Deborah Barnard
committed
add TOC and version history section
1 parent 246155d commit 9fbef7d

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

.editorconfig

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ trim_trailing_whitespace = true
1212
indent_style = space
1313
indent_size = 2
1414

15+
[*.md]
16+
trim_trailing_whitespace = false
17+
1518
[*.yml]
1619
indent_style = space
1720
indent_size = 2

README_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ _App/service name_ is _one or two sentences describing the service this node int
66

77
[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
88

9+
[Installation](#installation)
10+
[Operations](#operations)
11+
[Credentials](#credentials) <!-- delete if no auth needed -->
12+
[Compatibility](#compatibility)
13+
[Usage](#usage) <!-- delete if not using this section -->
14+
[Resources](#resources)
15+
[Version history](#version-history) <!-- delete if not using this section -->
16+
917
## Installation
1018

1119
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._
1826

1927
_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._
2028

29+
## Compatibility
30+
31+
_State the minimum n8n version, as well as which versions you test against. You can also include any known version incompatibility issues._
32+
2133
## Usage
2234

2335
_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
2941
* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
3042
* _Link to app/service documentation._
3143

44+
## Version history
45+
46+
_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._
47+
3248

0 commit comments

Comments
 (0)