Skip to content

Commit 2021078

Browse files
committed
Add tests docs link
1 parent dd2c3fd commit 2021078

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ A library that wraps the PHP FTP functions in an OOP way.
1616

1717
## Installation
1818

19-
The recommended way to install this package is by composer:
19+
The recommended way to install this library is through composer:
2020

2121
```console
2222
composer require lazzard/php-ftp-client
@@ -32,11 +32,11 @@ git clone https://github.com/lazzard/php-ftp-client
3232

3333
### Usage
3434
```php
35-
// Create an FTP connection
35+
// create an FTP connection
3636
$connection = new FtpConnection("localhost", "foo", "12345");
3737
$connection->open();
3838

39-
// Configure an FtpConnection
39+
// configure an FtpConnection
4040
$config = new FtpConfig($connection);
4141
$config->setPassive(true);
4242

@@ -57,7 +57,7 @@ $client->asyncDownload('illustrations/assets.zip', 'assets.zip', function ($stat
5757
// do something every second while downloading this file
5858
});
5959

60-
// Upload a remote file asynchronously
60+
// upload a remote file asynchronously
6161
$client->asyncUpload('wallpapers.zip', 'public_html', function ($state) {
6262
// do something
6363
});
@@ -66,26 +66,26 @@ $client->asyncUpload('wallpapers.zip', 'public_html', function ($state) {
6666
#### listing
6767

6868
```php
69-
// Get files names within an FTP directory
69+
// get files names within an FTP directory
7070
$client->listDirectory('public_html');
7171

72-
// Get only directories
72+
// get only directories
7373
$client->listDirectory('public_html', FtpClient::DIR_TYPE);
7474

75-
// Get detailed information of each file within an FTP directory including the file path
75+
// get detailed information of each file within an FTP directory including the file path
7676
$client->listDirectoryDetails('public_html');
7777

78-
// Recursively
78+
// recursively
7979
$client->listDirectoryDetails('public_html', true);
8080
```
8181

8282
#### size
8383

8484
```php
85-
// Get file size
85+
// get file size
8686
$client->fileSize('public_html/presentation.docx');
8787

88-
// Get directory size
88+
// get directory size
8989
$client->dirSize('public_html/presentation.docx');
9090
```
9191

@@ -98,7 +98,7 @@ $client->createFile('public_html/example.txt');
9898
// create a file with content
9999
$client->createFile('public_html/example.txt', 'Hello world!!');
100100

101-
// Get directory size
101+
// get directory size
102102
$client->createDirectory('public_html/presentation.docx');
103103
```
104104

@@ -131,7 +131,7 @@ $client->getCount($directory);
131131
// recursively
132132
$client->getCount($directory, true);
133133

134-
// recursively and files type only
134+
// recursively and files only
135135
$client->getCount($directory, true, FtpClient::FILE_TYPE);
136136
```
137137

@@ -199,12 +199,14 @@ You can see all the methods [here](docs/FtpClient.md).
199199
* [The base class FtpClient][3]
200200
* [Sending commands with FtpCommand][4]
201201
* [Using the FtpWrapper][5]
202+
* [How i can run tests ?][6]
202203

203204
[1]: docs/FtpConnectionInterface.md
204205
[2]: docs/FtpConfig.md
205206
[3]: docs/FtpClient.md
206207
[4]: docs/FtpCommand.md
207208
[5]: docs/FtpWrapper.md
209+
[6]: docs/tests.md
208210

209211
## License
210212

0 commit comments

Comments
 (0)