Update README.md

Author: Olivier Roques

README.md

@@ -7,14 +7,14 @@ SSH library [paramiko](https://github.com/paramiko/paramiko/).
 ## Installation
 Run:
 ```
-pip3 install --user sshcontroller-oroques
+pip3 install --user sshcontroller
 ```
 
-Note that the package has been exclusively tested on Python 3+.
+Note that the package has been exclusively tested on Python 3.6+.
 
 ## Usage
 
-The code snippets can also be found at [demo.py](./examples/demo.py).
+All code snippets can also be found at [demo.py](./examples/demo.py).
 
 #### 1. Create a new SSH controller from a SSH key
 ```python
@@ -26,7 +26,7 @@ KEY_PWD = "password"
 ssh_controller = sshcontroller.SSHController(
     host=HOST_IP,
     user="olivier",
-    key_path="~/.ssh/id_rsa",  # if omitted, look in agent and in ~/.ssh
+    key_path="~/.ssh/id_rsa",  # if omitted, look for keys in SSH agent and in ~/.ssh/
     key_password=KEY_PWD,      # optional
     key_type="rsa",            # rsa (default), dsa, ecdsa or ed25519
     port=22,                   # 22 is the default
@@ -43,11 +43,11 @@ ssh_controller.connect()
 return_code, output = ssh_controller.run(
     command="echo 'Hello world!' > /tmp/hello.txt",
     display=True,          # display output, false by default
-    combine_stderr=False,  # combine stderr and stdout, false by default
     capture_output=True,   # return output, false by default
+    combine_stderr=False,  # combine stderr and stdout, false by default
     timeout=10,            # command timeout in seconds, 600s by default
 )
-logging.info(f"return code: {return_code}, output: {output}")
+print(f"return code: {return_code}, output: {output}")
 ```
 
 #### 4. Transfer data with SFTP
@@ -56,10 +56,10 @@ All functions from paramiko's `SFTPClient` are available through the
 [paramiko's documentation](http://docs.paramiko.org/en/stable/api/sftp.html#paramiko.sftp_client.SFTPClient)
 for a complete list.
 
-In addition, the package adds new methods:
+In addition, the package implements additional methods:
 * `exists(path)`: check that a file or a directory exists on the remote host
 * `list_dirs(path)`: return the list of directories present in `path`
-* `list_dirs(path)`: return the list of files present in `path`
+* `list_files(path)`: return the list of files present in `path`
 
 ```python
 print(f"hello.txt exists: {ssh_controller.exists('/tmp/hello.txt')}")
@@ -77,29 +77,29 @@ with open("/tmp/bonjour.txt", 'r') as bonjour:
 ssh_controller.disconnect()
 ```
 
-#### 6. Use SSH password instead
+#### 6. Use a SSH password instead of a key
 ```python
 import sshcontroller
 
 HOST_IP = "93.184.216.34"  # an IPv4 or IPv6 address
-SSH_PWD = ""
+SSH_PWD = "password"
 
 ssh_controller = sshcontroller.SSHController(
     host=HOST_IP,
-    user="root",
+    user="olivier",
     ssh_password=SSH_PWD
 )
 ssh_controller.connect()
 ```
 
 #### 7. Run a command until an event is set
-If the argument `stop_event` is set when calling `run()`, the controller waits
-for the given event to be triggered before stopping. This is especially useful
-when using threads.
+If the argument `stop_event` is set when calling `run()`, the controller
+ignores `timeout` and stops only when the given event is triggered instead.
+This is especially useful when using threads.
 
 The example below starts two threads with an event attached to each one:
 one is pinging localhost, the other sleeps for 10s. When the sleeping threads
-has finished, we trigger the events to also stop the pinging thread.
+has finished, the events are triggered to also stop the pinging thread.
 
 ```python
 import logging
@@ -108,6 +108,8 @@ import sshcontroller
 import threading
 import time
 
+# ... set up ssh_controller here ...
+
 output = queue.Queue()  # a queue to store the ping command output
 stop_event_sleep = threading.Event()
 stop_event_ping = threading.Event()

examples/demo.py

@@ -16,7 +16,7 @@ def demo_key():
     ssh_controller = sshcontroller.SSHController(
         host=HOST_IP,
         user="olivier",
-        key_path="~/.ssh/id_rsa",  # if omitted, look in agent and in ~/.ssh
+        key_path="~/.ssh/id_rsa",  # if omitted, look for keys in SSH agent and in ~/.ssh/
         key_password=KEY_PWD,      # optional
         key_type="rsa",            # rsa (default), dsa, ecdsa or ed25519
         port=22,                   # 22 is the default
@@ -27,8 +27,8 @@ def demo_key():
     return_code, output = ssh_controller.run(
         command="echo 'Hello world!' > /tmp/hello.txt",
         display=True,          # display output, false by default
-        combine_stderr=False,  # combine stderr and stdout, false by default
         capture_output=True,   # return output, false by default
+        combine_stderr=False,  # combine stderr and stdout, false by default
         timeout=10,            # command timeout in seconds, 600s by default
     )
     logging.info(f"return code: {return_code}, output: {output}")
@@ -48,7 +48,7 @@ def demo_key():
 def demo_pwd():
     ssh_controller = sshcontroller.SSHController(
         host=HOST_IP,
-        user="root",
+        user="olivier",
         ssh_password=SSH_PWD
     )
     ssh_controller.connect()