node-red/README.md

51 lines
1.6 KiB
Markdown
Raw Normal View History

2013-09-05 16:02:48 +02:00
# Node-RED
http://nodered.org
[![Build Status](https://travis-ci.org/node-red/node-red.png)](https://travis-ci.org/node-red/node-red) [![Coverage Status](https://coveralls.io/repos/node-red/node-red/badge.png?branch=master)](https://coveralls.io/r/node-red/node-red?branch=master)
2014-04-14 10:51:55 +02:00
2013-09-05 16:02:48 +02:00
A visual tool for wiring the Internet of Things.
2013-10-02 21:37:28 +02:00
![Screenshot](http://nodered.org/images/node-red-screenshot.png "Node-RED: A visual tool for wiring the Internet of Things")
2013-09-05 16:02:48 +02:00
## Quick Start
2013-09-05 16:27:35 +02:00
Check out [INSTALL](INSTALL.md) for full instructions on getting started.
2013-09-05 16:02:48 +02:00
1. download the zip and unzip, or git clone
2. cd node-red
3. npm install
4. node red.js
2013-09-05 16:10:33 +02:00
5. Open <http://localhost:1880>
2013-09-05 16:02:48 +02:00
2015-02-06 14:16:46 +01:00
## Getting Help
2013-09-26 22:12:31 +02:00
More documentation can be found [here](http://nodered.org/docs).
2015-02-06 14:16:46 +01:00
For further help, or general discussion, please use the [mailing list](https://groups.google.com/forum/#!forum/node-red).
2013-10-04 22:44:00 +02:00
2013-09-05 16:02:48 +02:00
## Browser Support
The Node-RED editor runs in the browser. We routinely develop and test using
2015-02-06 14:16:46 +01:00
Chrome and Firefox. We have anecdotal evidence that it works in recent versions of IE.
2013-09-05 16:02:48 +02:00
2015-02-06 14:16:46 +01:00
We have basic support for using in mobile/tablet browsers.
2013-09-05 16:02:48 +02:00
## Contributing
2015-02-06 14:16:46 +01:00
Before raising a pull-request, please read our [contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md).
2013-09-05 21:39:33 +02:00
2013-09-05 16:02:48 +02:00
## Authors
2014-04-14 10:51:55 +02:00
Node-RED is a creation of [IBM Emerging Technology](http://ibm.com/blogs/et).
2013-09-05 16:02:48 +02:00
2013-09-05 16:04:48 +02:00
* Nick O'Leary [@knolleary](http://twitter.com/knolleary)
* Dave Conway-Jones [@ceejay](http://twitter.com/ceejay)
2013-09-05 16:02:48 +02:00
2014-04-14 10:51:55 +02:00
For more open-source projects from IBM, head over [here](http://ibm.github.io).
2013-09-05 16:02:48 +02:00
## Copyright and license
2015-02-06 14:16:46 +01:00
Copyright 2013, 2015 IBM Corp. under [the Apache 2.0 license](LICENSE).