Skip to content

Commit ccc8313

Browse files
authored
docs: add new search streams action to the readme, improve installation process instructions, and add dark/light mode image (#16)
1 parent 00279f9 commit ccc8313

File tree

4 files changed

+44
-20
lines changed

4 files changed

+44
-20
lines changed

README.md

Lines changed: 44 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<p align="center">
22
<a href="https://codely.com">
3-
<img src="https://user-images.githubusercontent.com/10558907/170513882-a09eee57-7765-4ca4-b2dd-3c2e061fdad0.png" width="300px" height="92px"/>
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="https://codely.com/logo/codely_logo-dark.svg">
5+
<source media="(prefers-color-scheme: light)" srcset="https://codely.com/logo/codely_logo-light.svg">
6+
<img alt="Codely logo" src="https://codely.com/logo/codely_logo.svg">
7+
</picture>
48
</a>
59
</p>
610

@@ -9,41 +13,62 @@
913
</h1>
1014

1115
<p align="center">
12-
<a href="https://github.com/CodelyTV"><img src="https://img.shields.io/badge/Codely-OS-green.svg?style=flat-square" alt="Codely Open Source"/></a>
13-
<a href="https://pro.codely.com"><img src="https://img.shields.io/badge/Codely-Pro-black.svg?style=flat-square" alt="Codely Courses"/></a>
16+
<a href="https://github.com/CodelyTV"><img src="https://img.shields.io/badge/Codely-OS-green.svg?style=flat-square" alt="Codely Open Source projects"/></a>
17+
<a href="https://pro.codely.com"><img src="https://img.shields.io/badge/Codely-Pro-black.svg?style=flat-square" alt="Codely Pro courses"/></a>
18+
</p>
19+
20+
<p align="center">
21+
Trigger workflows on stream start or stream end, search for Twitch streams details…
1422
</p>
1523

1624
<p align="center">
17-
Trigger workflows on stream start, stream end, new follows…
18-
<br />
19-
<br />
2025
<a href="https://github.com/CodelyTV/n8n-nodes-twitch/stargazers">Stars welcomed 😊</a>
2126
</p>
2227

2328
# 👀 n8n Twitch node features
2429

25-
Once installed, you will be able to add Twitch triggers to your n8n workflows.
30+
Once installed, you will be able to add Twitch triggers and actions to your n8n workflows.
2631

2732
1. Search for Twitch node:
2833

29-
<img alt="Twitch node in the n8n nodes panel" src="/docs/node.png" width="420" height="225">
30-
2. Select the desired trigger:
34+
<img alt="Twitch node in the n8n nodes panel" src="/docs/node.png" width="336" height="180">
35+
36+
2. Select the desired action or trigger:
37+
38+
<img alt="Twitch node triggers" src="/docs/node-actions-and-triggers.png" width="336" height="504">
3139

32-
<img alt="Twitch node triggers" src="/docs/triggers.png" width="420" height="377">
3340
3. Parametrize it:
3441

35-
<img alt="Twitch node parameters" src="/docs/node-parameters.png" width="420" height="438">
42+
<img alt="Twitch node parameters" src="/docs/node-parameters.png" width="336" height="350">
3643

3744
# 🚀 Installation instructions
3845

3946
This node is in the process to be officially verified by n8n.
40-
The installation process will be much simpler once we get that verification,
41-
but in the meantime, you have several options.
42-
The first thing to check is the [updated n8n instructions
43-
on how to install community nodes](https://docs.n8n.io/integrations/community-nodes/installation/),
44-
and depending on your n8n setup, you could take advantage of one of the following alternatives:
47+
The installation process will be as simple as searching for "Twitch" in the nodes panel once we get that verification,
48+
but in the meantime, you have several options that depend on how you use n8n.
49+
50+
We recommend checking out the [updated n8n instructions
51+
on how to install community nodes](https://docs.n8n.io/integrations/community-nodes/installation/) for possible updates to this process.
52+
53+
## a) n8n cloud instance
54+
55+
It is not possible to install unverified community nodes in n8n cloud ([documentation](https://docs.n8n.io/integrations/community-nodes/installation/)).
56+
Once we get that verification, you will be able to install this node following [this step by step](https://docs.n8n.io/integrations/community-nodes/installation/verified-install/).
57+
58+
## b) Self-hosted n8n instance
59+
60+
### b.a) Not using queue mode: GUI installation
61+
62+
Follow [the official instructions](https://docs.n8n.io/integrations/community-nodes/installation/gui-install/)
63+
specifying `@codelytv/n8n-nodes-twitch` as the node name to install:
64+
65+
<img alt="Twitch community node installation" src="/docs/node-installation.png" width="336" height="241">
66+
67+
## b.b) Using queue mode
68+
69+
### b.b.a) Install as npm package
4570

46-
## a) Self-hosted n8n instance: npm package
71+
This is the officially recommended way for self-hosted n8n instances running in queue mode ([documentation](https://docs.n8n.io/integrations/community-nodes/installation/manual-install/).
4772

4873
Go to the folder where n8n is installed (if you are using the standard Docker installation, it will probably be:
4974
`/usr/local/lib/node_modules/n8n`) and install the package as any other npm package:
@@ -52,7 +77,7 @@ Go to the folder where n8n is installed (if you are using the standard Docker in
5277
npm i @codelytv/n8n-nodes-twitch
5378
```
5479

55-
## b) Self-hosted n8n instance: Custom Docker image
80+
### b.b.b) Install as Custom Docker image
5681

5782
`Dockerfile` contents example for a custom image with this node added:
5883

@@ -65,7 +90,7 @@ RUN if [ -z "$N8N_VERSION" ]; then echo "💥 N8N_VERSION argument missing."; ex
6590
npm install --prefix /home/node/.n8n/nodes --production --silent @codelytv/n8n-nodes-twitch
6691
```
6792

68-
## c) Self-hosted n8n instance: Docker Compose / Docker Swarm with mapped volume
93+
### b.b.c) Install using Docker Compose / Docker Swarm with mapped volume
6994

7095
Take into account that this option has a considerable downside:
7196
The workflows you create will contain `CUSTOM.twitchTrigger` as the node type reference instead of `@codelytv/n8n-nodes-twitch.twitchTrigger`. However, it could be the best approach if you want a faster feedback loop while developing.
@@ -180,6 +205,5 @@ Publishing this package we are committing ourselves to the following code qualit
180205
- 🤝 Respect **Semantic Versioning**: No breaking changes in patch or minor versions
181206
- 🤏 No surprises in transitive dependencies: Use the **bare minimum dependencies** needed to meet the purpose
182207
- 🎯 **One specific purpose** to meet without having to carry a bunch of unnecessary other utilities
183-
- ✅ **Tests** as documentation and usage examples
184208
- 📖 **Well documented ReadMe** showing how to install and use
185209
- ⚖️ **License favoring Open Source** and collaboration

docs/node-actions-and-triggers.png

10.7 KB
Loading

docs/node-installation.png

9.11 KB
Loading

docs/triggers.png

-17.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)