Skip to content

Commit d36a3ba

Browse files
committed
Improve documentation and fix typo
1 parent 3efd8dc commit d36a3ba

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# clue/reactphp-zlib
22

3-
[![CI status](https://github.com/clue/reactphp-zlib/workflows/CI/badge.svg)](https://github.com/clue/reactphp-zlib/actions)
3+
[![CI status](https://github.com/clue/reactphp-zlib/actions/workflows/ci.yml/badge.svg)](https://github.com/clue/reactphp-zlib/actions)
44
[![installs on Packagist](https://img.shields.io/packagist/dt/clue/zlib-react?color=blue&label=installs%20on%20Packagist)](https://packagist.org/packages/clue/zlib-react)
55

66
Streaming zlib compressor and decompressor for [ReactPHP](https://reactphp.org/),
@@ -54,7 +54,7 @@ See also the [examples](examples).
5454
## Formats
5555

5656
This library is a lightweight wrapper around the underlying zlib library.
57-
The zlib library offers a number of different formats (sometimes referred to as *encodings*) detailled below.
57+
The zlib library offers a number of different formats (sometimes referred to as *encodings*) detailed below.
5858

5959
### GZIP format
6060

@@ -179,13 +179,14 @@ This project follows [SemVer](https://semver.org/).
179179
This will install the latest supported version:
180180

181181
```bash
182-
$ composer require clue/zlib-react:^1.1
182+
composer require clue/zlib-react:^1.1
183183
```
184184

185185
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
186186

187187
This project aims to run on any platform and thus does not require any PHP
188188
extensions besides `ext-zlib` and supports running on PHP 7 through current PHP 8+.
189+
It's *highly recommended to use the latest supported PHP version* for this project.
189190

190191
The `ext-zlib` extension is required for handling the underlying data compression
191192
and decompression.
@@ -202,7 +203,7 @@ require `ext-zlib` during installation but uses runtime checks instead.
202203
In this case, you can install this project like this:
203204

204205
```bash
205-
$ composer require "clue/zlib-react:^1.0||^0.2.2"
206+
composer require "clue/zlib-react:^1.0||^0.2.2"
206207
```
207208

208209
## Tests
@@ -211,13 +212,13 @@ To run the test suite, you first need to clone this repo and then install all
211212
dependencies [through Composer](https://getcomposer.org/):
212213

213214
```bash
214-
$ composer install
215+
composer install
215216
```
216217

217218
To run the test suite, go to the project root and run:
218219

219220
```bash
220-
$ php vendor/bin/phpunit
221+
vendor/bin/phpunit
221222
```
222223

223224
## License

0 commit comments

Comments
 (0)