help updated

pull/1344/head
aniket-engg 3 years ago committed by joseph izang
parent 44de0d8819
commit 7ee2d2ae8f
  1. 16
      libs/remixd/README.md
  2. 2
      libs/remixd/src/bin/remixd.ts

@ -26,19 +26,21 @@ If you were using the old one you need to:
## HELP SECTION ## HELP SECTION
``` ```
Usage: remixd -s <shared folder> --remix-ide https://remix.ethereum.org Usage: remixd -s <shared folder>
Provide a two-way connection between the local computer and Remix IDE.
Provide a two-way connection between the local computer and Remix IDE
Options: Options:
-v, --version output the version number
--remix-ide <url> URL of remix instance allowed to connect to this -u, --remix-ide <url> URL of remix instance allowed to connect to this web sockect connection
web sockect connection
-s, --shared-folder <path> Folder to share with Remix IDE -s, --shared-folder <path> Folder to share with Remix IDE
--read-only Treat shared folder as read-only (experimental) -r, --read-only Treat shared folder as read-only (experimental)
-h, --help output usage information -h, --help output usage information
Example:
remixd -s ./ -u http://localhost:8080
``` ```
## SHARE A FOLDER ## SHARE A FOLDER

@ -62,7 +62,7 @@ function errorHandler (error: any, service: string) {
.option('-s, --shared-folder <path>', 'Folder to share with Remix IDE') .option('-s, --shared-folder <path>', 'Folder to share with Remix IDE')
.option('-r, --read-only', 'Treat shared folder as read-only (experimental)') .option('-r, --read-only', 'Treat shared folder as read-only (experimental)')
.on('--help', function () { .on('--help', function () {
console.log('\nExample:\n\n remixd -s ./ --remix-ide http://localhost:8080') console.log('\nExample:\n\n remixd -s ./ -u http://localhost:8080')
}).parse(process.argv) }).parse(process.argv)
// eslint-disable-next-line // eslint-disable-next-line

Loading…
Cancel
Save