Skip to content

Commit 5c33751

Browse files
author
AmraniCh
committed
Updated README.md
1 parent d486381 commit 5c33751

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,21 @@
1-
# Lazzard/FtpClient
1+
[![Downloads](https://img.shields.io/packagist/dt/lazzard/php-ftp-client?style=flat-square)](https://packagist.org/packages/lazzard/php-ftp-client)
2+
[![Packagist Version](https://img.shields.io/packagist/v/lazzard/php-ftp-client?style=flat-square)](https://packagist.org/packages/lazzard/php-ftp-client)
3+
[![Minimum PHP version](https://img.shields.io/packagist/php-v/lazzard/php-ftp-client?style=flat-square)](https://packagist.org/packages/lazzard/php-ftp-client)
4+
![License](https://img.shields.io/packagist/l/lazzard/php-ftp-client?style=flat-square)
25

3-
[![Downloads](https://img.shields.io/packagist/dt/lazzard/php-ftp-client)](https://packagist.org/packages/lazzard/php-ftp-client)
4-
[![Packagist Version](https://img.shields.io/packagist/v/lazzard/php-ftp-client)](https://packagist.org/packages/lazzard/php-ftp-client)
5-
[![Minimum PHP version](https://img.shields.io/packagist/php-v/lazzard/php-ftp-client?color=%238892bf)](https://packagist.org/packages/lazzard/php-ftp-client)
6-
![License](https://img.shields.io/packagist/l/lazzard/php-ftp-client)
6+
# Lazzard/FtpClient
77

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

1010
*Note: This library aimed to be a full FTP/FTPS client solution for the old **(^5.5)** and newer PHP releases **(^8.0)**
1111
that support FTP extension.*
1212

13-
## Installation
14-
15-
The recommended way to install this library is through composer :
13+
## Quick Start
1614

1715
```
1816
composer require lazzard/php-ftp-client
1917
```
2018

21-
## Quick Start
22-
2319
```php
2420
<?php
2521

@@ -31,6 +27,10 @@ use Lazzard\FtpClient\FtpClient;
3127
use Lazzard\FtpClient\Exception\FtpClientException;
3228

3329
try {
30+
if (!extension_loaded('ftp')) {
31+
throw new \RuntimeException("FTP extension not loaded.");
32+
}
33+
3434
$connection = new FtpSSLConnection('host', 'username', 'password');
3535
$connection->open();
3636

@@ -42,7 +42,8 @@ try {
4242
print_r($client->getFeatures());
4343

4444
$connection->close();
45-
} catch (FtpClientException $ex) {
45+
46+
} catch (\Throwable $ex) {
4647
print_r($ex->getMessage());
4748
}
4849
```
@@ -260,26 +261,27 @@ $client->keepAlive();
260261

261262
## Version Guidance
262263

263-
| Version | Status | Last Release | PHP Version |
264-
|:----------:|:-------------:|:------------:|:-------------:|
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.* |
264+
| Version | Status | Last Release | PHP Version |
265+
|:-------:|:------:|:------------:|:-----------:|
266+
| 1.0.x | EOL | [v1.0.2][7] | >= 5.5 |
267+
| 1.4.x | EOL | [v1.4.2][9] | >= 5.6 |
268+
| 1.5.x | EOL | [v1.5.3][9] | ^7.2 \| 8.0.* |
269+
| 1.6.x | Latest | [v1.6.0][10] | ^7.4 \| 8.0.* |
268270

269271
[7]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.0.2
270272

271273
[8]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.1.0
272274

273275
[9]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.5.3
274276

277+
[10]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.6.0
278+
275279
## Contribution
276280

277281
Feel free to fork this repo if you want to enhance it or adding new features, also reported some issues that may have
278282
you facing while using the library will be very appreciated, Thank you!
279283

280-
## Library supporters
281-
282-
Thanks to JetBrains company for providing tools that really help us to continue maintaining this project.
284+
## They support this project
283285

284286
<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"/>
285287

0 commit comments

Comments
 (0)