webssh

commit e1cd3efdf0534ec4a8244dfaa0e4316dd5d16af6
parent 34af59a1c9c1ac2cf9cc492649d268e5cc2bb730
Author: Sheng <webmaster0115@gmail.com>
Date:   Sun, 19 May 2019 20:19:51 +0800

Updated README

Diffstat:
M
README.md
 | 
15
++++++++++-----
M
README.rst
 | 
16
+++++++++++-----

2 files changed, 21 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
@@ -6,11 +6,11 @@
 ![PyPI](https://img.shields.io/pypi/v/webssh.svg)
 
 
-## Introduction
+### Introduction
 
 A simple web application to be used as an ssh client to connect to your ssh servers. It is written in Python, base on tornado, paramiko and xterm.js.
 
-## Features
+### Features
 
 * SSH password authentication supported, including empty password.
 * SSH public-key authentication supported, including DSA RSA ECDSA Ed25519 keys.
@@ -21,7 +21,7 @@ A simple web application to be used as an ssh client to connect to your ssh serv
 * Modern browsers including Chrome, Firefox, Safari, Edge, Opera supported.
 
 
-## Preview
+### Preview
 
 ![Login](https://github.com/huashengdun/webssh/raw/master/preview/login.png)
 ![Terminal](https://github.com/huashengdun/webssh/raw/master/preview/terminal.png)
@@ -114,7 +114,12 @@ http://localhost:8888/#bgcolor=green
 
 Passing a user defined title
 ```bash
-http://localhost:8888/?title=my-webssh-server
+http://localhost:8888/?title=my-ssh-server
+```
+
+Passing an encoding
+```bash
+http://localhost:8888/#encoding=gbk
 ```
 
 ### Use Docker
@@ -168,7 +173,7 @@ wssh --port=8080 --sslport=4433 --certfile='cert.crt' --keyfile='cert.key' --xhe
 ```
 
 
-## Tips
+### Tips
 
 * For whatever deployment choice you choose, don't forget to enable SSL.
 * By default plain http requests from a public network will be either redirected or blocked and being redirected takes precedence over being blocked.
diff --git a/README.rst b/README.rst
@@ -4,14 +4,14 @@ WebSSH
 |Build Status| |codecov| |PyPI - Python Version| |PyPI|
 
 Introduction
-------------
+~~~~~~~~~~~~
 
 A simple web application to be used as an ssh client to connect to your
 ssh servers. It is written in Python, base on tornado, paramiko and
 xterm.js.
 
 Features
---------
+~~~~~~~~
 
 -  SSH password authentication supported, including empty password.
 -  SSH public-key authentication supported, including DSA RSA ECDSA
@@ -24,7 +24,7 @@ Features
    supported.
 
 Preview
--------
+~~~~~~~
 
 |Login| |Terminal|
 
@@ -125,7 +125,13 @@ Passing a user defined title
 
 .. code:: bash
 
-    http://localhost:8888/?title=my-webssh-server
+    http://localhost:8888/?title=my-ssh-server
+
+Passing an encoding
+
+.. code:: bash
+
+    http://localhost:8888/#encoding=gbk
 
 Use Docker
 ~~~~~~~~~~
@@ -187,7 +193,7 @@ Running as a standalone server
     wssh --port=8080 --sslport=4433 --certfile='cert.crt' --keyfile='cert.key' --xheaders=False --policy=reject
 
 Tips
-----
+~~~~
 
 -  For whatever deployment choice you choose, don't forget to enable
    SSL.