1
0
mirror of https://github.com/node-red/node-red-nodes.git synced 2023-10-10 13:36:58 +02:00
node-red-nodes/README.md
Nicholas O'Leary 00a766e513 Update README
2013-09-26 22:03:08 +01:00

45 lines
1.6 KiB
Markdown

# Node-RED Nodes
A collection of nodes for [Node-RED](http://nodered.org).
## Installation
Eventually, the nodes will be npm-installable, but we're not there yet. Until then:
1. cd into the `nodes` directory of Node-RED
2. Either:
- download the zip of the repository and extract it
- run `git clone https://github.com/node-red/node-red-nodes.git`
3. npm install any of the individual node dependencies
This is all too manual, so the sooner we npm-enable this stuff the better
## Contributing
Please read the Contributing section of the main project [README](https://github.com/node-red/node-red/blob/master/README.md)
The key points are:
- try to follow the conventions we use (all undocumented at the moment just to make it interesting)
- focus on the UX of the node - make it simple to do simple things and simple to do advanced things. Don't
force a user wanting to do simple things have to wade through the advanced things.
- avoid duplication
### Contributor License Agreement
In order for us to accept pull-requests, the contributor must first complete
a Contributor License Agreement (CLA). This clarifies the intellectual
property license granted with any contribution. It is for your protection as a
Contributor as well as the protection of IBM and its customers; it does not
change your rights to use your own Contributions for any other purpose.
Once you have created a pull-request, we'll provide a link to the appropriate
CLA document.
If you are an IBMer, please contact us directly as the contribution process is
slightly different.
## Copyright and license
Copyright 2013 IBM Corp. under [the Apache 2.0 license](LICENSE).