Change command name to 'logout' and document in README.MD

mscdex · May 20, 2014 · e56c104 · e56c104
1 parent 9d6a05c
commit e56c104
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -154,6 +154,8 @@ Methods
 
 * **rename**(< _string_ >oldPath, < _string_ >newPath, < _function_ >callback) - _(void)_ - Renames `oldPath` to `newPath` on the server. `callback` has 1 parameter: < _Error_ >err.
 
+* **logout**(< _function_ >callback) - _(void)_ - Logout the user from the server. `callback` has 1 parameter: < _Error_ >err.
+
 * **delete**(< _string_ >path, < _function_ >callback) - _(void)_ - Deletes a file, `path`, on the server. `callback` has 1 parameter: < _Error_ >err.
 
 * **cwd**(< _string_ >path, < _function_ >callback) - _(void)_ - Changes the current working directory to `path`. `callback` has 2 parameters: < _Error_ >err, < _string_ >currentDir. Note: `currentDir` is only given if the server replies with the path in the response text.

diff --git a/lib/connection.js b/lib/connection.js
@@ -370,7 +370,7 @@ FTP.prototype.rename = function(from, to, cb) {
   });
 };
 
-FTP.prototype.quit = function(cb) {
+FTP.prototype.logout = function(cb) {
   this._send('QUIT', cb);
 };