diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 90922e6f4..000000000 --- a/INSTALL.md +++ /dev/null @@ -1,57 +0,0 @@ -Node-RED Install -================ - -## Install node.js - -You can get the latest version from . - -Or, you may want to use a version from your operating system's package manager: - - -## Get Node-RED - -Clone the repository from GitHub: - - $ git clone git@github.com:node-red/node-red.git - -## Install the pre-requisite modules - -From the top-level directory of Node-RED, run: - - $ npm install - -This will install the core pre-requisite modules. - -## Run Node-RED - -From the top-level directory, run: - - $ node red.js - -You can then access Node-RED at . - -Online documentation is available at . - -## Installing individual node dependencies - -When Node-RED starts, it attempts to load the nodes from the `nodes/` directory. -Each will have its own set of dependencies that will need to be installed before -the node is available in the palette. - -To help identify the dependencies, Node-RED logs any modules it fails to find -for a particular node. You don't have to install these unless you want or need -that node to appear. - -Alternatively, a node's `.js` file can be examined to identify the modules it -explicitly requires. For example, the Twitter node is defined in -`nodes/social/27-twitter.js` and contains: - - var RED = require("../../red/red"); - var ntwitter = require('ntwitter'); - var OAuth= require('oauth').OAuth; - -Of these, `ntwitter` and `oauth` are neither built-in modules nor ones provided -by Node-RED itself. They can subsequently be installed by running: - - $ npm install ntwitter oauth - diff --git a/README.md b/README.md index 614afc2f4..142db0a9f 100644 --- a/README.md +++ b/README.md @@ -2,39 +2,33 @@ 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) - +[![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) A visual tool for wiring the Internet of Things. -![Screenshot](http://nodered.org/images/node-red-screenshot.png "Node-RED: A visual tool for wiring the Internet of Things") +![Node-RED: A visual tool for wiring the Internet of Things](http://nodered.org/images/node-red-screenshot.png) ## Quick Start -Check out [INSTALL](INSTALL.md) for full instructions on getting started. +Check out http://nodered.org/docs/getting-started/ for full instructions on getting +started. -1. download the zip and unzip, or git clone -2. cd node-red -3. npm install -4. node red.js -5. Open +1. `sudo npm install -g node-red` +2. `node-red` +3. Open ## Getting Help More documentation can be found [here](http://nodered.org/docs). -For further help, or general discussion, please use the [mailing list](https://groups.google.com/forum/#!forum/node-red). - -## 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 recent versions of IE. - -We have basic support for using in mobile/tablet browsers. +For further help, or general discussion, please use the +[mailing list](https://groups.google.com/forum/#!forum/node-red). ## Contributing -Before raising a pull-request, please read our [contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md). +Before raising a pull-request, please read our +[contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md). ## Authors @@ -48,3 +42,4 @@ For more open-source projects from IBM, head over [here](http://ibm.github.io). ## Copyright and license Copyright 2013, 2015 IBM Corp. under [the Apache 2.0 license](LICENSE). +