Skip to content

Commit 874e1f3

Browse files
committed
Updated README.md
1 parent a9624a6 commit 874e1f3

File tree

1 file changed

+39
-16
lines changed

1 file changed

+39
-16
lines changed

README.md

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77

88
This library provides helper classes and methods to manage your FTP files in an OOP way.
99

10-
*Note: This library aimed to be a full FTP/FTPS client solution for the old **(^5.5)** and newer PHP releases **(^8.0)** that support FTP extension.*
10+
*Note: This library aimed to be a full FTP/FTPS client solution for the old **(^5.5)** and newer PHP releases **(^8.0)**
11+
that support FTP extension.*
1112

1213
## Installation
1314

@@ -125,7 +126,7 @@ $client->dirSize('path/to/directory');
125126
```
126127

127128
#### file/directory creating
128-
129+
129130
```php
130131
// create an FTP file
131132
$client->createFile('path/to/file');
@@ -138,6 +139,13 @@ $client->createFile('path/to/file', 'Hello world!!');
138139
$client->createDir('directory');
139140
```
140141

142+
#### append
143+
144+
```php
145+
// append the giving content to a remote file
146+
$client->appendFile('path/to/file', $content);
147+
```
148+
141149
#### remove/rename
142150

143151
```php
@@ -171,7 +179,7 @@ $client->getCount('path/to/directory', true);
171179
$client->getCount('path/to/directory', true, FtpClient::FILE_TYPE);
172180
```
173181

174-
#### permissions
182+
#### permissions
175183

176184
```php
177185
// set a permissions on the giving FTP file/directory
@@ -204,7 +212,7 @@ $client->isExists('path/to/file/or/directory');
204212
$client->isFeatureSupported('SIZE');
205213
```
206214

207-
#### others
215+
#### others
208216

209217
```php
210218
// get the last modified time of the giving file (not working with directories)
@@ -226,39 +234,54 @@ $client->allocateSpace(2048);
226234
// prevent the server from closing the connection and keeping it alive
227235
$client->keepAlive();
228236
```
237+
229238
*You can see all available methods [here](docs/FtpClient.md).*
230239

231240
## More documentation
232241

233-
* [Manipulate the FTP connection with **ConnectionInterface**.][1]
234-
* [Configure the connection instance with **FtpConfig**.][2]
235-
* [Start working with the base class **FtpClient**.][3]
236-
* [Sending FTP commands with **FtpCommand**.][4]
237-
* [How to use the **FtpWrapper** class directly.][5]
238-
* [Running the integration tests.][6]
239-
242+
* [Manipulate the FTP connection with **ConnectionInterface**.][1]
243+
* [Configure the connection instance with **FtpConfig**.][2]
244+
* [Start working with the base class **FtpClient**.][3]
245+
* [Sending FTP commands with **FtpCommand**.][4]
246+
* [How to use the **FtpWrapper** class directly.][5]
247+
* [Running the integration tests.][6]
248+
240249
[1]: docs/ConnectionInterface.md
250+
241251
[2]: docs/FtpConfig.md
252+
242253
[3]: docs/FtpClient.md
254+
243255
[4]: docs/FtpCommand.md
256+
244257
[5]: docs/FtpWrapper.md
258+
245259
[6]: docs/tests.md
246260

247261
## Version Guidance
248262

249263
| Version | Status | Last Release | PHP Version |
250264
|:----------:|:-------------:|:------------:|:-------------:|
251-
| 1.0.x | EOL | [v1.0.2][7] | >= 5.5 |
252-
| 1.4.x | EOL | [v1.4.2][9] | >= 5.6 |
253-
| 1.5.x | Latest | [v1.5.0][9] | ^7.2 \| 8.0.* |
265+
| 1.0.x | EOL | [v1.0.2][7] | > = 5.5 |
266+
| 1.4.x | EOL | [v1.4.2][9] | > = 5.6 |
267+
| 1.5.x | Latest | [v1.5.3][9] | ^7.2 \| 8.0.* |
254268

255269
[7]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.0.2
270+
256271
[8]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.1.0
257-
[9]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.5.0
272+
273+
[9]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.5.3
258274

259275
## Contribution
260276

261-
Feel free to fork this repo if you want to enhance it or adding new features, also reported some issues that may have you facing while using the library will be very appreciated, Thank you!
277+
Feel free to fork this repo if you want to enhance it or adding new features, also reported some issues that may have
278+
you facing while using the library will be very appreciated, Thank you!
279+
280+
## Library supporters
281+
282+
Thanks to JetBrains company for providing tools that really help us to continue maintaining this project.
283+
284+
<img width="150" src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png?_gl=1*1evhn6q*_ga*MzA3MTk5NzQ3LjE2MzU3OTk3MDA.*_ga_V0XZL7QHEB*MTYzNTg5MzE3NS4yLjEuMTYzNTg5MzkzNC4xNg..&_ga=2.162913596.1450626373.1635893177-307199747.1635799700"/>
262285

263286
## License
264287

0 commit comments

Comments
 (0)