From 3f3dfb3f0891d95622dbbb35c547a262f29a202a Mon Sep 17 00:00:00 2001 From: naimo84 Date: Wed, 3 Nov 2021 15:41:43 +0100 Subject: [PATCH] Add documentation --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f4acd1a..a603394 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ It provides a browser-based editor that makes it easy to wire together flows usi ## Contents - [Installation](#installation) +- [Documentation](#documentation) - [Nodes](#nodes) - [Analysis](#analysis) - [Database](#database) @@ -18,8 +19,7 @@ It provides a browser-based editor that makes it easy to wire together flows usi - [I/O](#io) - [Parsers](#parsers) - [Smarthome](#smarthome) - - [Social](#social) - - [Storage](#storage) + - [Social](#social) - [System](#system) - [Time](#time) - [Utility](#utility) @@ -36,6 +36,12 @@ It provides a browser-based editor that makes it easy to wire together flows usi - [RedMatic](https://github.com/rdmtc/RedMatic/wiki/Installation) - Install Node-RED on a CCU3, smart home automation hardware from the manufacturer eQ-3, popular especially in Germany. - [ioBroker node-red Adapter](https://github.com/ioBroker/ioBroker.node-red) - Starts Node-RED instance within ioBroker and communicates with it. +## Documentation + +- [Getting Started](https://nodered.org/docs/getting-started/) +- [FAQ](https://nodered.org/docs/faq/) +- [Tutorials](https://nodered.org/docs/tutorials/) +- [User Guide](https://nodered.org/docs/user-guide/) ## Nodes ### Analysis @@ -49,6 +55,9 @@ It provides a browser-based editor that makes it easy to wire together flows usi - [node-red-contrib-mssql-plus](https://github.com/bestlong/node-red-contrib-mssql-plus) - Execute queries, stored procedures and bulk inserts in Microsoft SQL Server and Azure Databases SQL2000 ~ SQL2019. - [node-red-contrib-stackhero-influxdb-v2](https://github.com/stackhero-io/node-red-contrib-stackhero-influxdb-v2) - Save and query data from an InfluxDB v2 time series database. - [node-red-contrib-stackhero-mysql](https://github.com/stackhero-io/node-red-contrib-stackhero-mysql) - Connect to a MySQL or a MariaDB database, using TLS (SSL) and compatible with "Caching SHA2 password" authentication method (MySQL >= 8). +- [node-red-node-leveldb](https://github.com/node-red/node-red-nodes/tree/master/storage/leveldb) - Uses LevelDB for a simple key value pair database. +- [node-red-node-mysql](https://github.com/node-red/node-red-nodes/tree/master/storage/mysql) - Allows basic access to a MySQL database. This node uses the **query** operation against the configured database. This does allow both INSERTS and DELETES. By it's very nature it allows SQL injection. *so be careful out there* +- [node-red-node-sqlite](https://github.com/node-red/node-red-nodes/tree/master/storage/sqlite) - Supports read and write to a local sqlite database. ### Development @@ -159,12 +168,6 @@ It provides a browser-based editor that makes it easy to wire together flows usi - [node-red-contrib-whatsappbot](https://github.com/robertsLando/node-red-contrib-whatsappbot) - Whatsapp Bot. - [node-red-node-xmpp](https://github.com/node-red/node-red-nodes/tree/master/social/xmpp) - Connects to an XMPP server to send and receive messages. -### Storage - -- [node-red-node-leveldb](https://github.com/node-red/node-red-nodes/tree/master/storage/leveldb) - Uses LevelDB for a simple key value pair database. -- [node-red-node-mysql](https://github.com/node-red/node-red-nodes/tree/master/storage/mysql) - Allows basic access to a MySQL database. This node uses the **query** operation against the configured database. This does allow both INSERTS and DELETES. By it's very nature it allows SQL injection. *so be careful out there* -- [node-red-node-sqlite](https://github.com/node-red/node-red-nodes/tree/master/storage/sqlite) - Supports read and write to a local sqlite database. - ### System - [node-red-contrib-aedes](https://github.com/martin-doyle/node-red-contrib-aedes) - MQTT Broker based on Aedes.