Merge pull request #66 from LianaHus/patch-1

Update README.md

README.md

@@ -1,15 +1,15 @@
 # Remixd
 
-Remixd is a tool that intend to be used with [Remix IDE](http://github.com/ethereum/browser-solidity) (aka. Browser-Solidity). It allows a websocket connection between
+`remixd` is a tool that intend to be used with [Remix IDE](http://github.com/ethereum/browser-solidity) (aka. Browser-Solidity). It allows a websocket connection between
 `Remix IDE` (web application) and the local computer.
 
-Practically Remix IDE make available a folder shared by Remixd.
+Practically Remix IDE make available a folder shared by `remixd`.
 
 More details are explained in this [tutorial](http://remix.readthedocs.io/en/latest/tutorial_remixd_filesystem.html).
 
-Alternatively Remixd can be used to setup a development environment that can be used with other popular frameworks like Embark, Truffle, Ganache, etc..
+Alternatively `remixd` can be used to setup a development environment that can be used with other popular frameworks like Embark, Truffle, Ganache, etc..
 
-Remixd needs `npm` and `node`
+`remixd` needs `npm` and `node`
 
 ## INSTALLATION
 
@@ -25,16 +25,20 @@ Remixd needs `npm` and `node`
 
   Options:
 
-    -s, --shared-folder <path>            Folder to share with Remix IDE
+  --remix-ide  <url>                    URL of remix instance allowed to connect to this web sockect connection
-    -m, --mist                            start mist
+  -s, --shared-folder <path>            Folder to share with Remix IDE
-    -g, --geth                            start geth
+  --read-only                           Treat shared folder as read-only (experimental)
-    -p, --dev-path <dev-path>             Folder used by mist/geth to start the development instance
+  --vyper                               Run a local vyper compiler
-    -f, --frontend <front-end>            Folder that should be served by remixd
+  -m, --mist                            start mist
-    -p, --frontend-port <front-end-port>  Http port used by the frontend (default 8082)
+  -g, --geth                            start geth
-    -a, --auto-mine                       mine pending transactions
+  -p, --dev-path <dev-path>             Folder used by mist/geth to start the development instance
-    -r, --rpc <cors-domains>              start rpc server. Values are CORS domain
+  -f, --frontend <front-end>            Folder that should be served by remixd
-    -rp, --rpc-port                       rpc server port (default 8545)
+  -p, --frontend-port <front-end-port>  Http port used by the frontend (default 8082)
-    -h, --help                            output usage information
+  -a, --auto-mine                       mine pending transactions
+  -r, --rpc <cors-domains>              start rpc server. Values are CORS domain
+  -rp, --rpc-port                       rpc server port (default 8545)
+  --profiler                            start profiler service
+  -h, --help                            output usage information
 
 ```