diff --git a/.editorconfig b/.editorconfig index fdda219..cff7816 100644 --- a/.editorconfig +++ b/.editorconfig @@ -12,6 +12,9 @@ trim_trailing_whitespace = true indent_style = space indent_size = 2 +[*.md] +trim_trailing_whitespace = false + [*.yml] indent_style = space indent_size = 2 diff --git a/README_TEMPLATE.md b/README_TEMPLATE.md index cc76107..22c905d 100644 --- a/README_TEMPLATE.md +++ b/README_TEMPLATE.md @@ -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. +[Installation](#installation) +[Operations](#operations) +[Credentials](#credentials) +[Compatibility](#compatibility) +[Usage](#usage) +[Resources](#resources) +[Version history](#version-history) + ## Installation 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._ +## Compatibility + +_State the minimum n8n version, as well as which versions you test against. You can also include any known version incompatibility issues._ + ## Usage _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/) * _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._ +