Updated README with installation docs

README.md

@@ -7,10 +7,46 @@
 
 - NodeJS version 8 or 9
 - [yarn][yarn] dependency manager
+- [catapult-server][catapult-server] configured as an [API node][api-node].
+
+## Installation
+
+1. Edit ``rest/resources/rest.json`` configuration:
+
+| Parameter | Description | Example  |
+|-|-|-|
+| clientPrivateKey | REST client private key. | 000...000|
+| db.url | MongoDB [connection URL](https://github.com/nemtech/catapult-server/blob/master/resources/config-database.properties#L3). | mongodb://localhost:27017/ |
+| apiNode.host | API node connection host. | 127.0.0.1 |
+| apiNode.port | API node [connection port](https://github.com/nemtech/catapult-server/blob/master/resources/config-node.properties#L3). | 7900 |
+|api.publicKey | API node [public key](https://github.com/nemtech/catapult-server/blob/master/resources/config-user.properties#L4). | FFFF...FFF|
+| websocket.mq.host | ZeroMQ connection host. |  127.0.0.1 |
+| websocket.mq.port | ZeroMQ [connection port](https://github.com/nemtech/catapult-server/blob/master/resources/config-messaging.properties#L3). | 7902 |
+
+> **Note:** catapult-rest has to reach the API node, ZeroMQ and MongoDB ports. If you are running catapult-server on a VPS, you can bind the ports to your local development environment creating an **SSH tunnel**: ``ssh -L 27017:localhost:27017 -L 7900:localhost:7900 -L 7902:localhost:7902 -p 2357 <USER>@<VPS_IP>``
+
+2. Install the project's dependencies:
+
+```
+./yarn_setup.sh
+```
+
+3. Run catapult-rest:
+
+```
+cd rest
+yarn start resources/rest.json
+```
+
+## Contributing
+
+Before contributing please [read this](CONTRIBUTING.md).
 
 ## License
 
 Copyright (c) 2018 Jaguar0625, gimre, BloodyRookie, Tech Bureau, Corp Licensed under the [GNU Lesser General Public License v3](LICENSE)
 
 
 [yarn]: https://yarnpkg.com/lang/en/
+[catapult-server]: https://yarnpkg.com/lang/en/
+[api-node]: https://nemtech.github.io/server.html#installation