From 246155d65e5804fc857d35e0f9404dcd5b2204e8 Mon Sep 17 00:00:00 2001 From: Deborah Barnard Date: Wed, 17 Aug 2022 16:10:14 +0100 Subject: [PATCH] readme template draft --- LICENSE.md | 2 +- README.md | 4 +++- README_TEMPLATE.md | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 36 insertions(+), 2 deletions(-) create mode 100644 README_TEMPLATE.md diff --git a/LICENSE.md b/LICENSE.md index cb69586..1e4b3a6 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -Copyright +Copyright 2022 n8n Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/README.md b/README.md index c384c07..43f0671 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,9 @@ These are the basic steps for working with the starter. For detailed guidance on 6. Update the `package.json` to match your details. 7. Run `npm run lint` to check for errors or `npm run lintfix` to automatically fix errors when possible. 8. Test your node locally. Refer to [Run your node locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/) for guidance. -9. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm. +9. Replace this README with documentation for your node. Use the [README_TEMPLATE](README_TEMPLATE.md) to get started. +10. Update the LICENSE file to use your details. +11. [Publish](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry) your package to npm. ## More information diff --git a/README_TEMPLATE.md b/README_TEMPLATE.md new file mode 100644 index 0000000..cc76107 --- /dev/null +++ b/README_TEMPLATE.md @@ -0,0 +1,32 @@ +# n8n-nodes-_node-name_ + +This is an n8n community node. It lets you use _app/service name_ in your n8n workflows. + +_App/service name_ is _one or two sentences describing the service this node integrates with_. + +[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform. + +## Installation + +Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation. + +## Operations + +_List the operations supported by your node._ + +## Credentials + +_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._ + +## Usage + +_This is an optional section. Use it to help users with any difficult or confusing aspects of the node._ + +_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._ + +## Resources + +* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/) +* _Link to app/service documentation._ + +