chore: Add note to README about error raising

mlibrary · Mar 27, 2024 · ce1d903 · ce1d903
1 parent 160ab73
commit ce1d903
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -86,6 +86,8 @@ SFTP.client.ls("directory")
 # returns ["file1.txt"]
 ```
 
+If a failure occurs when an underlying `sftp` command is run, an `SFTP::Error` will be raised.
+
 ## Development
 
 Clone the repo