Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jenky committed Sep 27, 2023
1 parent 49ac713 commit 82375d0
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

A simple and efficient solution for concurrently sending HTTP requests using PSR-18 client implementations.

Peak is a library that enables concurrent request sending using a request pool. It leverages the event loop of [ReactPHP](https://github.com/reactphp) or [PSL](https://github.com/azjezz/psl) to handle and manage the requests concurrently.
Peak is a library that enables concurrent request sending using a request pool. It leverages the event loop of [AMPHP](https://github.com/amphp), [ReactPHP](https://github.com/reactphp) or [PSL](https://github.com/azjezz/psl) to handle and manage the requests concurrently.

## Requirements

Expand All @@ -26,6 +26,12 @@ composer require fansipan/peak

Additionally, depending on your choice of driver, these packages may also need to be installed.

### AMPHP

```bash
composer require amphp/pipeline
```

### PSL

```bash
Expand Down Expand Up @@ -60,9 +66,13 @@ The `Fansipan\Peak\PoolFactory` provides a configured request pool based on the
First, you need to create your desired driver:

```php
use Fansipan\Peak\Concurrency\AmpDeferred;
use Fansipan\Peak\Concurrency\PslDeferred;
use Fansipan\Peak\Concurrency\ReactDeferred;

// AMPHP
$defer = new AmpDeferred();

// PSL
$defer = new PslDeferred();

Expand Down

0 comments on commit 82375d0

Please sign in to comment.