Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AmraniCh committed Jan 31, 2022
1 parent d486381 commit 5c33751
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,21 @@
# Lazzard/FtpClient
[![Downloads](https://img.shields.io/packagist/dt/lazzard/php-ftp-client?style=flat-square)](https://packagist.org/packages/lazzard/php-ftp-client)
[![Packagist Version](https://img.shields.io/packagist/v/lazzard/php-ftp-client?style=flat-square)](https://packagist.org/packages/lazzard/php-ftp-client)
[![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)
![License](https://img.shields.io/packagist/l/lazzard/php-ftp-client?style=flat-square)

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

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

*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.*

## Installation

The recommended way to install this library is through composer :
## Quick Start

```
composer require lazzard/php-ftp-client
```

## Quick Start

```php
<?php

Expand All @@ -31,6 +27,10 @@ use Lazzard\FtpClient\FtpClient;
use Lazzard\FtpClient\Exception\FtpClientException;

try {
if (!extension_loaded('ftp')) {
throw new \RuntimeException("FTP extension not loaded.");
}

$connection = new FtpSSLConnection('host', 'username', 'password');
$connection->open();

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

$connection->close();
} catch (FtpClientException $ex) {

} catch (\Throwable $ex) {
print_r($ex->getMessage());
}
```
Expand Down Expand Up @@ -260,26 +261,27 @@ $client->keepAlive();

## Version Guidance

| Version | Status | Last Release | PHP Version |
|:----------:|:-------------:|:------------:|:-------------:|
| 1.0.x | EOL | [v1.0.2][7] | >= 5.5 |
| 1.4.x | EOL | [v1.4.2][9] | >= 5.6 |
| 1.5.x | Latest | [v1.5.3][9] | ^7.2 \| 8.0.* |
| Version | Status | Last Release | PHP Version |
|:-------:|:------:|:------------:|:-----------:|
| 1.0.x | EOL | [v1.0.2][7] | >= 5.5 |
| 1.4.x | EOL | [v1.4.2][9] | >= 5.6 |
| 1.5.x | EOL | [v1.5.3][9] | ^7.2 \| 8.0.* |
| 1.6.x | Latest | [v1.6.0][10] | ^7.4 \| 8.0.* |

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

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

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

[10]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.6.0

## Contribution

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!

## Library supporters

Thanks to JetBrains company for providing tools that really help us to continue maintaining this project.
## They support this project

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

Expand Down

0 comments on commit 5c33751

Please sign in to comment.