search

connio / node-red-contrib-connio

Node-Red module for Connio nodes
MIT License
0 stars 0 forks source link

Improve package description page #39

Closed bmrb closed 4 years ago

bmrb commented 4 years ago

We like to add the following sections and text to the package page:

Screen Shot 2019-12-11 at 2 45 45 PM

Title: Node-RED nodes for the Connio platform

Overview

A collection of Node-RED nodes to communicate with the Connio platform. The first group of nodes (Connio Edge) allows you to bi-directionally communicate with the platform from your devices and gateways. You can use these nodes from a Node-RED instance installed within your device. The second group (Connio Cloud) allows you to connect external services to the platform to consume device data and send device commands easily.

Connio offers an Internet of Things (IoT) platform that enables businesses to quickly connect, integrate and orchestrate their products and operations within IoT ecosystem.

You can register to the Connio platform at https://app.connio.cloud. Check the platform documentation at https://docs.connio.com.

Install

If installing from within Node-RED, use the Manage Palette menu command and search for node-red-contrib-connio.

Or, from a command line within your Node-RED user directory, enter:

npm install node-red-contrib-connio

Configuration

Connio nodes will have an Account and Deployment property which must be configured. Deployment property allows you to select the Connio deployment or host that you like to use in your flow. Account property allows you to select the Connio account you like to use. You only have to set this configuration once and use it in all your nodes.

Screen Shot 2019-12-11 at 6 29 25 PM Screen Shot 2019-12-11 at 6 26 15 PM

Usage

Connio Edge nodes are designed to be used by remote devices for communicating with the platform.

Connio Cloud nodes are designed to be used by external systems (web services, mobile apps, etc...) for communicating with the platform.

See node documentation to better understand each node usage.

Copyright and license

Copyright 2019, 2020 Connio Inc. under the Apache 2.0 license.

ivan-gerasimov-1 commented 4 years ago

@bmrb Regarding Maintainers field — looks like it is npm username, so there is no way to change it to Connio Inc.

ivan-gerasimov-1 commented 4 years ago

Done (skipped copyright and license section until clarification) Version 0.5.5

bmrb commented 4 years ago

Change title as shown above.

Screen Shot 2019-12-12 at 9 42 44 AM
bmrb commented 4 years ago

(1) Put links to separate lines:

You can register to the Connio platform at https://app.connio.cloud.
Check the platform documentation at https://docs.connio.com.

(2) Also add this link (as a separate line) to the overview section:

See Node-RED tutorial at https://docs.connio.com/docs/integration-node-red.

ivan-gerasimov-1 commented 4 years ago

(1) Put links to separate lines

Fixed

(2) Also add this link (as a separate line) to the overview section:

Done

Regarding the title, looks like they use a description field from package.json instead of a header in README.md. I have updated the description to match the title. We will see once the version will be published

Also added Copyright and license section

Version 0.5.6