diff --git a/README.md b/README.md index 0c738e9..9bdf165 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,25 @@ wssh.reset_encoding(); wssh.send('ls -l'); ``` +### URL Arguments + +Spport passing arugments by url (hash or search) like following examples: + +Passing form data +```bash +http://localhost:8888/?hostname=xx&username=yy +``` + +Passing a terminal background color +```bash +http://localhost:8888/#bgcolor=green +``` + +Passing a user defined title +```bash +http://localhost:8888/?title=my-webssh-server +``` + ### Use Docker Start up the app diff --git a/README.rst b/README.rst index 9e71108..008537d 100644 --- a/README.rst +++ b/README.rst @@ -103,6 +103,30 @@ Browser console // send a command to the server wssh.send('ls -l'); +URL Arguments +~~~~~~~~~~~~~ + +Spport passing arugments by url (hash or search) like following +examples: + +Passing form data + +.. code:: bash + + http://localhost:8888/?hostname=xx&username=yy + +Passing a terminal background color + +.. code:: bash + + http://localhost:8888/#bgcolor=green + +Passing a user defined title + +.. code:: bash + + http://localhost:8888/?title=my-webssh-server + Use Docker ~~~~~~~~~~