node-red/README.md

45 lines
1.2 KiB
Markdown
Raw Normal View History

2013-09-05 14:02:48 +00:00
# Node-RED
A visual tool for wiring the Internet of Things.
2013-10-02 19:37:28 +00:00
![Screenshot](http://nodered.org/images/node-red-screenshot.png "Node-RED: A visual tool for wiring the Internet of Things")
2013-09-05 14:02:48 +00:00
## Quick Start
2013-09-05 14:27:35 +00:00
Check out [INSTALL](INSTALL.md) for full instructions on getting started.
2013-09-05 14:02:48 +00:00
1. download the zip and unzip, or git clone
2. cd node-red
3. npm install
4. node red.js
2013-09-05 14:10:33 +00:00
5. Open <http://localhost:1880>
2013-09-05 14:02:48 +00:00
2013-09-26 20:12:31 +00:00
## Documentation
More documentation can be found [here](http://nodered.org/docs).
2013-10-04 20:44:00 +00:00
For further help, or general discussion, there is also a [mailing list](https://groups.google.com/forum/#!forum/node-red).
2013-09-05 14:02:48 +00:00
## Browser Support
The Node-RED editor runs in the browser. We routinely develop and test using
Chrome and Firefox. We have anecdotal evidence that it works in IE9.
We do not yet support mobile browsers, although that is high on our priority
list.
## Contributing
2014-02-08 15:33:09 +00:00
Please see our [contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md).
2013-09-05 19:39:33 +00:00
2013-09-05 14:02:48 +00:00
## Authors
Node-RED is a creation of the IBM Emerging Technology Services team.
2013-09-05 14:04:48 +00:00
* Nick O'Leary [@knolleary](http://twitter.com/knolleary)
* Dave Conway-Jones [@ceejay](http://twitter.com/ceejay)
2013-09-05 14:02:48 +00:00
## Copyright and license
Copyright 2013 IBM Corp. under [the Apache 2.0 license](LICENSE).