1
0
mirror of https://github.com/danog/file.git synced 2024-12-03 09:47:54 +01:00
file/README.md

34 lines
1.2 KiB
Markdown
Raw Normal View History

2021-06-21 21:08:24 +02:00
# file ![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)
2015-07-11 03:59:39 +02:00
2017-06-21 10:26:39 +02:00
`amphp/file` allows non-blocking access to the filesystem for [Amp](https://github.com/amphp/amp).
2017-06-21 10:26:39 +02:00
## Installation
2015-07-11 03:59:39 +02:00
2017-06-21 10:26:39 +02:00
This package can be installed as a [Composer](https://getcomposer.org/) dependency.
2015-07-11 03:59:39 +02:00
2017-06-21 10:26:39 +02:00
```bash
composer require amphp/file
```
2015-07-11 03:59:39 +02:00
2017-06-21 10:26:39 +02:00
## Optional Extension Backends
2015-07-11 03:59:39 +02:00
2021-06-21 21:08:24 +02:00
Extensions allow using threading in the background instead of using multiple processes.
2017-06-21 10:26:39 +02:00
2021-06-21 21:08:24 +02:00
- [`ext-eio`](https://pecl.php.net/package/eio)
- [`ext-uv`](https://github.com/amphp/ext-uv)
- [`ext-parallel`](https://github.com/krakjoe/parallel)
2015-07-11 03:59:39 +02:00
2017-06-21 10:26:39 +02:00
`amphp/file` works out of the box without any PHP extensions. It uses multi-processing by default, but also comes with a blocking driver that just uses PHP's blocking functions in the current process.
2015-07-11 03:59:39 +02:00
2017-06-21 10:26:39 +02:00
## Versioning
2015-07-11 03:59:39 +02:00
2021-06-21 21:08:24 +02:00
`amphp/file` follows the [semver](https://semver.org/) semantic versioning specification like all other `amphp` packages.
2017-06-21 10:26:39 +02:00
## Security
If you discover any security related issues, please email [`me@kelunik.com`](mailto:me@kelunik.com) instead of using the issue tracker.
2017-06-21 10:26:39 +02:00
## License
The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.