Update docs

tlux · May 10, 2019 · 546002e · 546002e
1 parent 698fbe7
commit 546002e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -37,7 +37,8 @@ find out all available options.
 {:ok, conn} = SFTPClient.connect(host: "ftp.myhost.com")
 ```
 
-It is recommended to close a connection after your operations have completed:
+It is strongly recommended to close a connection after your operations have
+completed:
 
 ```elixir
 SFTPClient.disconnect(conn)

diff --git a/lib/sftp_client.ex b/lib/sftp_client.ex
@@ -5,13 +5,16 @@ defmodule SFTPClient do
 
   ## Connect & Disconnect
 
-  Use `connect/1` to open a new connection to an SFTP server. Refer to the docs to
-  find out all available options.
+  To open a new connection to an SFTP server:
 
       iex> {:ok, conn} = SFTPClient.connect(host: "ftp.myhost.com")
       {:ok, %SFTPClient.Conn{}}
 
-  It is recommended to close a connection after your operations have completed:
+  Refer to the docs for `SFTPClient.Operations.Connect.connect/1` to find out
+  all available options.
+
+  It is strongly recommended to close a connection after your operations have
+  completed:
 
       iex> SFTPClient.disconnect(conn)
       :ok