Docs updated

Author: klimov-paul

CHANGELOG.md

@@ -5,6 +5,7 @@ Yii 2 File Storage extension Change Log
 -----------------------
 
 - Enh #4: Added `yii2tech\filestorage\BucketInterface::openFile()` allowing to open file as a PHP resource (klimov-paul)
+- Enh #6: SFTP file storage implemented via `yii2tech\filestorage\sftp\Storage` (klimov-paul)
 - Enh #7: Usage of URL routes for `BucketInterface::getFileUrl()` provided (klimov-paul)
 
 

README.md

@@ -112,6 +112,7 @@ echo $bucket->getFileUrl('file.txt'); // outputs: 'http://domain.com/files/f/i/f
 
 Following file storages are available with this extension:
  - [[\yii2tech\filestorage\local\Storage]] - stores files on the OS local file system.
+ - [[\yii2tech\filestorage\sftp\Storage]] - stores files using SSH2 SFTP.
  - [[\yii2tech\filestorage\amazon\Storage]] - stores files using Amazon simple storage service (S3).
  - [[\yii2tech\filestorage\mongodb\Storage]] - stores files using MongoDB GridFS.
  - [[\yii2tech\filestorage\hub\Storage]] - allows combination of different file storages.

sftp/Storage.php

@@ -13,6 +13,8 @@
 /**
  * Storage introduces the file storage based on the SSH2 SFTP
  *
+ * This storage requires [PHP ssh2 extension](http://php.net/manual/en/book.ssh2.php) to be installed.
+ *
  * @see Connection
  *
  * @property resource $sftp related SFTP subsystem session.