Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify usage restriction of the plugin #39

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Clarify usage restriction of the plugin #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# FlowFuse Node-RED Assistant

A Node-RED plugin to assist FlowFuse users
A Node-RED plugin to assist FlowFuse users.

This plugin can only be used within FlowFuse-managed Node-RED instances.

## Installation

Expand All @@ -11,7 +12,7 @@ npm install @flowfuse/nr-assistant

## Development

Client-side portion of the plugin is in `index.js`. The server side code is in `index.js`
Client-side portion of the plugin is in `index.html`. The server side code is in `index.js`

## About

Expand All @@ -20,7 +21,9 @@ This plugin is designed to assist users of the FlowFuse platform by providing to
The capabilities it adds to Node-RED can be found in Node-RED editor on the main toolbar and within the function node editor.

## NOTES:

* Requires the settings.js file to contain the following:

```json
{
"flowforge": {
Expand All @@ -34,6 +37,10 @@ The capabilities it adds to Node-RED can be found in Node-RED editor on the main
}
```

These values are automatically set when running within the FlowFuse platform via the `nr-launcher` component.

The `url` and `token` are for an AI service hosted by FlowFuse; it is not publicly available for use outside of the FlowFuse platform.


## Limitations

Expand Down
Loading