Skip to content

Commit db5f3da

Browse files
committed
Readability improvements and better linking in readme
1 parent dd4d94b commit db5f3da

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,23 @@
22

33
This repository contains a third-party, node for the Node-RED Dashboard to provide an interactive chat window widget.
44

5-
Easily build a chat-based user interface, and seamlessly integrate it with the vast collection of other Node-RED nodes available.
5+
Easily build a chat-based user interface, and seamlessly integrate it with the vast collection of other Node-RED nodes available, including many for well-known AI services and offerings like [OpenAI](https://flows.nodered.org/node/@inductiv/node-red-openai-api) or [ollama](https://flows.nodered.org/node/node-red-contrib-ollama).
66

7-
<img width="1699" alt="Image" src="https://github.com/user-attachments/assets/4edf954b-bb53-4dd4-a353-5b5453d2d8ec" />
7+
Below is a demonstration of the chat widget in action, integrated with an OpenAI node to provide a chatbot interface, one trained on
8+
9+
## Examples
10+
11+
### OpenAI Chatbot
12+
13+
Here, an OpenAI agent was prompted that it is an expert in Node-RED, and should assist users with flow-building and answering general questions:
814

915
<img width="855" alt="Image" src="https://github.com/user-attachments/assets/c350daf5-a755-4d6b-a48d-310ca3eeb582" />
1016

17+
### Chat & Worldmap Integration
18+
19+
This agent was provisioned to provide coordinate data alongside it's text-based answers, which are then rendered onto a World Map, also rendered within FlowFuse Dashboard.
20+
21+
<img width="1699" alt="Image" src="https://github.com/user-attachments/assets/4edf954b-bb53-4dd4-a353-5b5453d2d8ec" />
1122

1223
## Usage
1324

@@ -29,6 +40,8 @@ npm install @flowfuse/node-red-dashboard-2-ui-chat
2940

3041
### Using in a Flow
3142

43+
<img width="964" alt="Image" src="https://github.com/user-attachments/assets/a6597ab4-bfc8-4358-8c2a-8c4b69ecbeda" />
44+
3245
Anything sent into the node will be considered as a _received_ message. Any messages typed into the chat will be sent out of the node as a _sent_ message.
3346

3447
#### Predefined Input Types

0 commit comments

Comments
 (0)