specify that the sudo detection is for remote commands on the Connection class

Signed-off-by: Alfredo Deza <alfredo@deza.pe>

diff --git a/README.rst b/README.rst
index 622c9262c9332b5801311519b1f77dff2a2e8e48..baa8af51158be1391a9c0f95a604faa339b5ccca 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -136,3 +136,13 @@ connecting to).
 If the local host has the same as the remote hostname, a local connection (via
 `Popen`) will be opened and that will be used instead of `ssh`, and avoiding
 the issues of being able to ssh into the same host.
+
+Automatic detection for using `sudo`
+------------------------------------
+This magical detection can be enabled by using the `detect_sudo` flag in the
+`Connection` class. It is disabled by default.
+
+When enabled, it will prefix any command with `sudo`. This is useful for
+libraries that need super user permissions and want to avoid passing `sudo`
+everywhere, which can be non-trivial if dealing with `root` users that are
+connecting via SSH.