Skip to content

Commit 2fc6bad

Browse files
committed
update README.md
1 parent 99d0c7b commit 2fc6bad

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

readme.md renamed to README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,30 @@
11
# node-red-contrib-arduino-iot-cloud
22

3-
This module implements node-red nodes for interacting with [Arduino IoT Cloud](https://create.arduino.cc/iot).
3+
This module implements Node-RED nodes for interacting with [Arduino IoT Cloud](https://create.arduino.cc/iot).
44
Multi Arduino Accounts are allowed.
55

6+
## Docker and Node-RED installation
7+
The easiest way to install Docker on a linux system is to use [the convenience script](https://docs.docker.com/engine/install/ubuntu/#install-using-the-convenience-script):
8+
```shell
9+
curl -sSL https://get.docker.com/ | sh
10+
```
11+
To install Node-RED you can use the [official docker container](https://hub.docker.com/r/nodered/node-red):
12+
```shell
13+
docker run -it -p 1880:1880 -v myNodeREDdata:/data --name mynodered nodered/node-red
14+
```
15+
16+
617
## Installation
7-
Install node-red-contrib-arduino-iot-cloud with:
18+
Just search *node-red-contrib-arduino-iot-cloud* in the Node-RED palette manager and click on install
819

9-
`npm install @arduino/node-red-contrib-arduino-iot-cloud`
20+
Or you can install the plugin by using `npm` in your `$HOME/.node-red` directory:
1021

11-
into your $HOME/.node-red directory or via node-red palette manager
22+
`npm install @arduino/node-red-contrib-arduino-iot-cloud`
1223

1324
## Configuration
14-
1. Obtain Client ID and Client Secret from the [things webpage](https://create.arduino.cc/iot/things) by clicking on *Add API*
15-
2. Go to NodeRED web page
16-
3. Select one Arduino node from the pallete and drag to a flow
25+
1. Obtain Client ID and Client Secret from the [integrations webpage](https://create.arduino.cc/iot/integrations) by clicking on *Create API key*
26+
2. Go to Node-RED web page
27+
3. Select one Arduino nodes from the pallete and drag to a flow
1728
4. Double click on the node
1829
* set a new connection
1930
+ select 'Add new arduino-connection...' in the field 'Connection'

0 commit comments

Comments
 (0)