docs: update README with local run guide (#704)

* docs: update README with local run guide

* refine README

* add code type

* format fix

* add wiki link

* suggestion fix

Co-authored-by: Kilian Rausch | ⚡ OpenDEX ⚡ <[email protected]>

Co-authored-by: raladev <[email protected]>
Co-authored-by: Kilian Rausch | ⚡ OpenDEX ⚡ <[email protected]>

Author: 3 people

README.md

@@ -50,5 +50,54 @@ git push origin your-feature-branch
 After the corresponding Travis build succeeded, other people can easily run your feature branch on their machine like this.
 
 ```bash
-./xud.sh -b your-feature-branch
+bash xud.sh -b your-feature-branch
 ```
+
+
+## Use local built images
+
+You can run xud-docker with your locally built images only:
+
+```bash
+git clone https://github.com/ExchangeUnion/xud-docker.git
+cd xud-docker
+git checkout -b local
+```
+
+#### Example: Use simnet (light mode)
+
+```bash
+tools/build utils xud lndbtc-simnet lndltc-simnet connext
+bash setup.sh -b local --dev --use-local-images xud,lndbtc,lndltc,connext
+```
+
+#### Example: Use testnet (light mode)
+
+```bash
+tools/build utils xud lndbtc lndltc connext
+bash setup.sh -b local --dev --use-local-images xud,lndbtc,lndltc,connext
+```
+
+#### Example: Use mainnet (light mode)
+
+See `images/utils/config/template.py` to get the right version of mainnet images
+
+```bash
+tools/build utils xud:1.0.0-rc.2 lndbtc:0.11.0-beta lndltc:0.11.0-beta.rc1 connext:1.3.1
+bash setup.sh -b local --dev --use-local-images xud,lndbtc,lndltc,connext
+```
+
+#### Example: Enable optional service arby
+
+Enabling boltz and webui works in a same way. 
+
+1. Build arby image `tools/build arby`
+2. Append `arby` to `--use-local-images`
+3. Append `--arby.disabled=false` or persist below in your network conf file
+
+```toml
+[arby]
+disabled = false
+```
+
+For more details about building and running local images please refer to [the wiki](https://github.com/ExchangeUnion/xud-docker/wiki/Build-and-run-local-images).