From bbb7d79b2ae371122a803c66fbee12d129983f90 Mon Sep 17 00:00:00 2001
From: Sheng <webmaster0115@gmail.com>
Date: Sat, 1 Sep 2018 11:20:31 +0800
Subject: [PATCH] Updated README and version

---
 README.md          | 44 ++++++++++++++++------------------------
 README.rst         | 50 ++++++++++++++++++----------------------------
 webssh/_version.py |  2 +-
 3 files changed, 37 insertions(+), 59 deletions(-)

diff --git a/README.md b/README.md
index 3ecc22d..8a8d5d7 100644
--- a/README.md
+++ b/README.md
@@ -9,11 +9,6 @@
 ## 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.
-```
-+---------+     http     +--------+    ssh    +-----------+
-| browser | <==========> | webssh | <=======> | ssh server|
-+---------+   websocket  +--------+    ssh    +-----------+
-```
 
 ## Features
 
@@ -31,6 +26,13 @@ A simple web application to be used as an ssh client to connect to your ssh serv
 ![Terminal](https://github.com/huashengdun/webssh/raw/master/preview/terminal.png)
 
 
+### How it works
+```
++---------+     http     +--------+    ssh    +-----------+
+| browser | <==========> | webssh | <=======> | ssh server|
++---------+   websocket  +--------+    ssh    +-----------+
+```
+
 ### Requirements
 
 * Python 2.7/3.4+
@@ -44,18 +46,6 @@ A simple web application to be used as an ssh client to connect to your ssh serv
 4. Input your data, submit the form.
 
 
-### Installation options
-
-Install from the pypi repository, may not the latest version
-```
-pip install webssh
-```
-
-Install from the github repository, always the latest version
-```
-pip install https://github.com/huashengdun/webssh/archive/master.zip
-```
-
 ### Server options
 
 ```bash
@@ -78,19 +68,10 @@ wssh --help
 ### Use console
 
 ```javascript
-// set a new encoding for client to use
-wssh.set_encoding(encoding);
-
-// reset encoding to use the default one
-wssh.reset_encoding();
-
 // connect to your ssh server
 wssh.connect(hostname, port, username, password, privatekey);
 
-// without an argument, wssh will use the form data to connect
-wssh.connect();
-
-// define a mapping object
+// define a object for wssh
 var opts = {
   hostname: 'hostname',
   port: 'port',
@@ -100,6 +81,15 @@ var opts = {
 };
 wssh.connect(opts);
 
+// without an argument, wssh will use the form data to connect
+wssh.connect();
+
+// set a new encoding for client to use
+wssh.set_encoding(encoding);
+
+// reset encoding to use the default one
+wssh.reset_encoding();
+
 // send a command to the server
 wssh.send('ls -l');
 ```
diff --git a/README.rst b/README.rst
index 73431de..1d8ae25 100644
--- a/README.rst
+++ b/README.rst
@@ -10,12 +10,6 @@ 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.
 
-::
-
-    +---------+     http     +--------+    ssh    +-----------+
-    | browser | <==========> | webssh | <=======> | ssh server|
-    +---------+   websocket  +--------+    ssh    +-----------+
-
 Features
 --------
 
@@ -32,6 +26,15 @@ Preview
 
 |Login| |Terminal|
 
+How it works
+~~~~~~~~~~~~
+
+::
+
+    +---------+     http     +--------+    ssh    +-----------+
+    | browser | <==========> | webssh | <=======> | ssh server|
+    +---------+   websocket  +--------+    ssh    +-----------+
+
 Requirements
 ~~~~~~~~~~~~
 
@@ -45,21 +48,6 @@ Quickstart
 3. Open your browser, navigate to ``127.0.0.1:8888``
 4. Input your data, submit the form.
 
-Installation options
-~~~~~~~~~~~~~~~~~~~~
-
-Install from the pypi repository, may not the latest version
-
-::
-
-    pip install webssh
-
-Install from the github repository, always the latest version
-
-::
-
-    pip install https://github.com/huashengdun/webssh/archive/master.zip
-
 Server options
 ~~~~~~~~~~~~~~
 
@@ -85,19 +73,10 @@ Use console
 
 .. code:: javascript
 
-    // set a new encoding for client to use
-    wssh.set_encoding(encoding);
-
-    // reset encoding to use the default one
-    wssh.reset_encoding();
-
     // connect to your ssh server
     wssh.connect(hostname, port, username, password, privatekey);
 
-    // without an argument, wssh will use the form data to connect
-    wssh.connect();
-
-    // define a mapping object
+    // define a object for wssh
     var opts = {
       hostname: 'hostname',
       port: 'port',
@@ -107,6 +86,15 @@ Use console
     };
     wssh.connect(opts);
 
+    // without an argument, wssh will use the form data to connect
+    wssh.connect();
+
+    // set a new encoding for client to use
+    wssh.set_encoding(encoding);
+
+    // reset encoding to use the default one
+    wssh.reset_encoding();
+
     // send a command to the server
     wssh.send('ls -l');
 
diff --git a/webssh/_version.py b/webssh/_version.py
index cb839c2..d48f983 100644
--- a/webssh/_version.py
+++ b/webssh/_version.py
@@ -1,2 +1,2 @@
-__version_info__ = (0, 3, 9)
+__version_info__ = (0, 4, 0)
 __version__ = '.'.join(map(str, __version_info__))