diff --git a/README.md b/README.md index bd74353..f4f383a 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ This will install the localtunnel module globally and add the 'lt' client cli to ## use ## -Super Easy! Assuming your local server is running on port 8000, just use the ```lt``` command to start the tunnel. +Assuming your local server is running on port 8000, just use the ```lt``` command to start the tunnel. ``` lt --port 8000 @@ -24,6 +24,13 @@ Thats it! It will connect to the tunnel server, setup the tunnel, and tell you w You can restart your local server all you want, ```lt``` is smart enough to detect this and reconnect once it is back. +### arguments + +Below are some common arguments. See `lt --help` for additional arguments + +* `--subdomain` request a named subdomain on the localtunnel server (default is random characters) +* `--local-host` proxy to a hostname other than localhost + ## API ## The localtunnel client is also usable through an API (for test integration, automation, etc) @@ -47,6 +54,7 @@ localtunnel(port, function(err, tunnel) { ### opts * `subdomain` A *string* value requesting a specific subdomain on the proxy server. **Note** You may not actually receive this name depending on availablily. +* `local_host` Proxy to this hostname instead of `localhost`. This will also cause the `Host` header to be re-written to this value in proxied requests. ### Tunnel