Skip to content

Commit 246155d

Browse files
author
Deborah Barnard
committed
readme template draft
1 parent 231c29c commit 246155d

File tree

3 files changed

+36
-2
lines changed

3 files changed

+36
-2
lines changed

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright <YEAR> <COPYRIGHT HOLDER>
1+
Copyright 2022 n8n
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy of
44
this software and associated documentation files (the "Software"), to deal in

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ These are the basic steps for working with the starter. For detailed guidance on
3434
6. Update the `package.json` to match your details.
3535
7. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible.
3636
8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance.
37-
9. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm.
37+
9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started.
38+
10. Update the LICENSE file to use your details.
39+
11. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm.
3840
3941
## More information
4042

README_TEMPLATE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# n8n-nodes-_node-name_
2+
3+
This is an n8n community node. It lets you use _app/service name_ in your n8n workflows.
4+
5+
_App/service name_ is _one or two sentences describing the service this node integrates with_.
6+
7+
[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
8+
9+
## Installation
10+
11+
Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
12+
13+
## Operations
14+
15+
_List the operations supported by your node._
16+
17+
## Credentials
18+
19+
_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._
20+
21+
## Usage
22+
23+
_This is an optional section. Use it to help users with any difficult or confusing aspects of the node._
24+
25+
_By the time users are looking for community nodes, they probably already know n8n basics. But if you expect new users, you can link to the [Try it out](https://docs.n8n.io/try-it-out/) documentation to help them get started._
26+
27+
## Resources
28+
29+
* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
30+
* _Link to app/service documentation._
31+
32+

0 commit comments

Comments
 (0)