diff --git a/libs/remixd/README.md b/libs/remixd/README.md index 21b18eb80a..648298445b 100644 --- a/libs/remixd/README.md +++ b/libs/remixd/README.md @@ -26,18 +26,20 @@ If you were using the old one you need to: ## HELP SECTION ``` - Usage: remixd -s --remix-ide https://remix.ethereum.org +Usage: remixd -s - 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 + -u, --remix-ide URL of remix instance allowed to connect to this web sockect connection + -s, --shared-folder Folder to share with Remix IDE + -r, --read-only Treat shared folder as read-only (experimental) + -h, --help output usage information - --remix-ide URL of remix instance allowed to connect to this - web sockect connection - -s, --shared-folder Folder to share with Remix IDE - --read-only Treat shared folder as read-only (experimental) - -h, --help output usage information +Example: + + remixd -s ./ -u http://localhost:8080 ``` diff --git a/libs/remixd/src/bin/remixd.ts b/libs/remixd/src/bin/remixd.ts index e783a927f0..2085735b8c 100644 --- a/libs/remixd/src/bin/remixd.ts +++ b/libs/remixd/src/bin/remixd.ts @@ -62,7 +62,7 @@ function errorHandler (error: any, service: string) { .option('-s, --shared-folder ', 'Folder to share with Remix IDE') .option('-r, --read-only', 'Treat shared folder as read-only (experimental)') .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) // eslint-disable-next-line