From ec7b25ab249ce4fa354e99a17d23857fc2aa82b1 Mon Sep 17 00:00:00 2001 From: kolaente Date: Tue, 24 Oct 2023 19:16:00 +0200 Subject: [PATCH] feat: update readme --- README.md | 62 ++++++++++++++++++++++------------------------ README_TEMPLATE.md | 48 ----------------------------------- 2 files changed, 29 insertions(+), 81 deletions(-) delete mode 100644 README_TEMPLATE.md diff --git a/README.md b/README.md index 43f0671..59f6396 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,43 @@ -![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png) +# n8n-nodes-vikunja -# n8n-nodes-starter +This is an n8n community node. It lets you use Vikunja in your n8n workflows. -This repo contains example nodes to help you get started building your own custom integrations for [n8n](n8n.io). It includes the node linter and other dependencies. +Vikunja is an open-source, self-hostable to-do and productivity application. +Check out [our website](https://vikunja.io/) for more information. -To make your custom node available to the community, you must create it as an npm package, and [submit it to the npm registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry). +[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform. -## Prerequisites +[Installation](#installation) +[Operations](#operations) +[Credentials](#credentials) +[Compatibility](#compatibility) +[Resources](#resources) -You need the following installed on your development machine: +## Installation -* [git](https://git-scm.com/downloads) -* Node.js and npm. Minimum version Node 16. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL [here](https://github.com/nvm-sh/nvm). For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows). -* Install n8n with: - ``` - npm install n8n -g - ``` -* Recommended: follow n8n's guide to [set up your development environment](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/). +Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation. +## Operations -## Using this starter +This node supports all operations supported by Vikunja API tokens. +You can see a full list of possible actions when creating a token in Vikunja. -These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the [documentation](https://docs.n8n.io/integrations/creating-nodes/). +It also allows you to trigger n8n workflows by Vikunja webhooks. -1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template repository. -2. Clone your new repo: - ``` - git clone https://github.com//.git - ``` -3. Run `npm i` to install dependencies. -4. Open the project in your editor. -5. Browse the examples in `/nodes` and `/credentials`. Modify the examples, or replace them with your own nodes. -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. 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. +## Credentials -## More information +The only supported authentication method for this node are API tokens. +On your Vikunja instance, head over to *Settings > API Tokens* and create a new token. -Refer to our [documentation on creating nodes](https://docs.n8n.io/integrations/creating-nodes/) for detailed information on building your own nodes. +In n8n, create credentials as you usually would. +Enter the API token created previously and the API url. -## License +## Compatibility -[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md) +Tested with n8n Version 1.9.3. + +## Resources + +* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/) +* [Vikunja n8n Docs](https://vikunja.io/docs/n8n) +* [Vikunja General Docs](https://vikunja.io/docs/) diff --git a/README_TEMPLATE.md b/README_TEMPLATE.md deleted file mode 100644 index 22c905d..0000000 --- a/README_TEMPLATE.md +++ /dev/null @@ -1,48 +0,0 @@ -# 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](#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. - -## 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._ - -## 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._ - -_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._ - -## 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._ - -