A professional template for creating well-documented n8n workflow repositories. This template provides everything you need to share your n8n workflows with the community, including automated documentation, visual diagrams, and contributor-friendly guidelines.

This workflow does [describe what your workflow does here]. It connects [list services/integrations] to [explain the outcome or value].

graph LR
    A[Trigger] --> B[Process Data]
    B --> C[Transform]
    C --> D[Output]
    D --> E[Complete]

Replace the diagram above with your actual workflow visualization. Mermaid diagrams render automatically on GitHub and the documentation site.

• n8n instance (version 1.0 or higher)
• [List any required credentials or API keys]
• [List any third-party service accounts needed]

1. Download the workflow file from this repository:

   wget https://raw.githubusercontent.com/[username]/[repo-name]/main/workflow/workflow.json

2. Import into n8n:

   • Open your n8n instance
   • Navigate to Workflows → Import from File
   • Select the downloaded workflow.json
   • Click Import

3. Configure credentials:

   • [Step-by-step credential setup]
   • [Environment variables needed]
   • [Any API keys or tokens]

4. Activate the workflow and test it.

If your workflow uses environment variables, document them here:

# Example configuration
VARIABLE_NAME=value
API_KEY=your-api-key-here

• Trigger: [Describe trigger type - webhook, schedule, manual, etc.]
• Execution: [Single execution, queue mode, etc.]
• Error handling: [How errors are handled]
• Timeout: [If applicable]

Explain how to use the workflow once it's set up:

1. [First step]
2. [Second step]
3. [Expected output]

[Optional: Document advanced features, customization options, or tips]

Full documentation is available on the project website.

For detailed setup instructions, see docs/setup-guide.md.

Contributions are welcome and encouraged! Whether you're fixing bugs, adding features, or improving documentation, your help makes this workflow better for everyone.

See CONTRIBUTING.md for guidelines on how to:

• Report issues
• Submit pull requests
• Suggest improvements
• Test workflow changes

All contributors will be recognized in the project.

[Optional: Explain the workflow architecture, node structure, or design decisions]

• [Component 1]: [Description]
• [Component 2]: [Description]
• [Component 3]: [Description]

Issue: [Common problem]

• Solution: [How to fix it]

Issue: [Another problem]

• Solution: [How to fix it]

See docs/setup-guide.md for more troubleshooting help.

See Releases for version history and updates.

This project is licensed under the MIT License - see the LICENSE file for details.

• Built with n8n
• [Any other tools or services used]
• [Credits to contributors or inspirations]

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Documentation: Project Website

Note: Replace all placeholders in brackets with your actual workflow information. Update the Mermaid diagram to match your workflow structure.