@@ -31,15 +31,27 @@ git clone https://github.com/lazzard/php-ftp-client
3131## Getting Started
3232
3333### Usage
34+
35+ Create an FTP connection
3436``` php
35- // create an FTP connection
36- $connection = new FtpConnection("localhost", "foo", "12345");
37+ $connection = new FtpConnection('host', 'foo', '1234');
3738$connection->open();
39+ ```
3840
39- // configure an FtpConnection
41+ Create a secure FTP connection
42+ ``` php
43+ $connection = new FtpSSLConnection('host', 'bar', '1234');
44+ $connection->open();
45+ ```
46+
47+ Configure the connection
48+ ``` php
4049$config = new FtpConfig($connection);
4150$config->setPassive(true);
51+ ```
4252
53+ Start working with ` FtpClient `
54+ ``` php
4355$client = new FtpClient($connection);
4456```
4557
@@ -183,7 +195,8 @@ $client->getFeatures();
183195// get the server system
184196$client->getSystem();
185197
186- // send a request to allocate a space of bytes for the next transfer operation (not all servers requires this)
198+ // send a request to allocate a space of bytes for the next transfer operation
199+ // note: not all servers requires this
187200$client->allocateSpace(2048);
188201
189202// prevent the server from closing the connection and keeping it alive
@@ -194,11 +207,11 @@ You can see all the methods [here](docs/FtpClient.md).
194207
195208## More documentation
196209
197- * [ FtpConnectionInterface] [ 1 ]
198- * [ Configure the connection with FtpConfig] [ 2 ]
199- * [ The base class FtpClient] [ 3 ]
200- * [ Sending commands with FtpCommand] [ 4 ]
201- * [ Using the FtpWrapper] [ 5 ]
210+ * [ Manipulate an FTP connection with ** FtpConnectionInterface** ] [ 1 ]
211+ * [ Configure the connection with ** FtpConfig** ] [ 2 ]
212+ * [ The base class ** FtpClient** ] [ 3 ]
213+ * [ Sending FTP raw commands with ** FtpCommand** ] [ 4 ]
214+ * [ Using the ** FtpWrapper** Directly ] [ 5 ]
202215 * [ How i can run tests ?] [ 6 ]
203216
204217[ 1 ] : docs/FtpConnectionInterface.md
0 commit comments