commit 41740690ac48a9066bb52bae0654cfc4cb3cbb72
parent a7a3f46609976510e1879b71c3c932f765c73d0b
Author: Sheng <webmaster0115@gmail.com>
Date: Thu, 30 Aug 2018 07:18:34 +0800
Updated README
Diffstat:
2 files changed, 6 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
@@ -38,8 +38,8 @@ A simple web application to be used as an ssh client to connect to your ssh serv
### Quickstart
-1. Install this app `pip install webssh`
-2. Start a webserver `wssh`
+1. Install this app, run command `pip install webssh`
+2. Start a webserver, run command `wssh`
3. Open your browser, navigate to `127.0.0.1:8888`
4. Input your data, submit the form.
@@ -77,7 +77,6 @@ wssh --help
### Use console
-
```javascript
// set a new encoding for client to use
wssh.set_encoding(encoding);
@@ -88,7 +87,7 @@ wssh.reset_encoding();
// connect to your ssh server
wssh.connect(hostname, port, username, password, privatekey);
-// without argument, wssh will use the form data to connect
+// without an argument, wssh will use the form data to connect
wssh.connect();
// define a mapping object
diff --git a/README.rst b/README.rst
@@ -40,8 +40,8 @@ Requirements
Quickstart
~~~~~~~~~~
-1. Install this app ``pip install webssh``
-2. Start a webserver ``wssh``
+1. Install this app, run command ``pip install webssh``
+2. Start a webserver, run command ``wssh``
3. Open your browser, navigate to ``127.0.0.1:8888``
4. Input your data, submit the form.
@@ -94,7 +94,7 @@ Use console
// connect to your ssh server
wssh.connect(hostname, port, username, password, privatekey);
- // without argument, wssh will use the form data to connect
+ // without an argument, wssh will use the form data to connect
wssh.connect();
// define a mapping object