Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
johnwedgbury authored Dec 11, 2023
1 parent c7ffeba commit 480f7b4
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PHP ZSTD

Can be used in PHP without the need to install an additional extension.
PHP library to allow [Zstandard](https://facebook.github.io/zstd/) compression and decompression, without the need to install an additional PHP extension.

## Dependencies

Expand Down Expand Up @@ -38,7 +38,7 @@ ZSTD::compress('path/to/file', 'path/to/output/file.zst');

### Advanced

Decompress from a stream, and handle the output yourself in chunks.
Decompress from a stream, and handle the output yourself in chunks. Can be used with custom filesystems etc to minimise memory usage.

```php
use Appoly\ZstdPhp\ZSTD;
Expand All @@ -57,7 +57,7 @@ ZSTD::decompressDataFromStream(
fclose($inputStream);
```

Compress to a stream (can be used with custom filesystems such as S3):
Compress from a stream, and handle the output yourself in chunks. Can be used with custom filesystems etc to minimise memory usage.

```php
use Appoly\ZstdPhp\ZSTD;
Expand Down

0 comments on commit 480f7b4

Please sign in to comment.