file/README.md

# file

[![Build Status](https://img.shields.io/travis/amphp/file/master.svg?style=flat-square)](https://travis-ci.org/amphp/file)
[![CoverageStatus](https://img.shields.io/coveralls/amphp/file/master.svg?style=flat-square)](https://coveralls.io/github/amphp/file?branch=master)
![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)

`amphp/file` allows non-blocking access to the filesystem for [Amp](https://github.com/amphp/amp).

## Installation

This package can be installed as a [Composer](https://getcomposer.org/) dependency.

```bash
composer require amphp/file
```

## Optional Extension Backends

Extensions allow to use threading in the background instead of using multiple processes.
 
 - [eio](https://pecl.php.net/package/eio)
 - [php-uv](https://github.com/bwoebi/php-uv)
 - [parallel](https://github.com/krakjoe/parallel)

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

## Versioning

`amphp/file` follows the [semver](http://semver.org/) semantic versioning specification like all other `amphp` packages.

## Security

If you discover any security related issues, please email [`me@kelunik.com`](mailto:me@kelunik.com) instead of using the issue tracker.

## License

The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
Transition from Filesystem -> File 2015-08-05 16:55:56 +02:00			`# file`
update readme 2015-07-18 21:06:19 +02:00
Transition from Filesystem -> File 2015-08-05 16:55:56 +02:00			`[![Build Status](https://img.shields.io/travis/amphp/file/master.svg?style=flat-square)](https://travis-ci.org/amphp/file)`
			`[![CoverageStatus](https://img.shields.io/coveralls/amphp/file/master.svg?style=flat-square)](https://coveralls.io/github/amphp/file?branch=master)`
update suport files to match amphp repo template 2015-07-28 15:53:00 +02:00			`![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)`
[WIP] initial code commit 2015-07-11 03:59:39 +02:00
Update LICENSE and README 2017-06-21 10:26:39 +02:00			`amphp/file` allows non-blocking access to the filesystem for [Amp](https://github.com/amphp/amp).
update suport files to match amphp repo template 2015-07-28 15:53:00 +02:00
Update LICENSE and README 2017-06-21 10:26:39 +02:00			`## Installation`
[WIP] initial code commit 2015-07-11 03:59:39 +02:00
Update LICENSE and README 2017-06-21 10:26:39 +02:00			`This package can be installed as a [Composer](https://getcomposer.org/) dependency.`
[WIP] initial code commit 2015-07-11 03:59:39 +02:00
Update LICENSE and README 2017-06-21 10:26:39 +02:00			```bash
			`composer require amphp/file`
			```
[WIP] initial code commit 2015-07-11 03:59:39 +02:00
Update LICENSE and README 2017-06-21 10:26:39 +02:00			`## Optional Extension Backends`
[WIP] initial code commit 2015-07-11 03:59:39 +02:00
Update LICENSE and README 2017-06-21 10:26:39 +02:00			`Extensions allow to use threading in the background instead of using multiple processes.`

			`- [eio](https://pecl.php.net/package/eio)`
			`- [php-uv](https://github.com/bwoebi/php-uv)`
Link to parallel extension instead of pthreads (#48) 2020-05-03 18:59:52 +02:00			`- [parallel](https://github.com/krakjoe/parallel)`
[WIP] initial code commit 2015-07-11 03:59:39 +02:00
Update LICENSE and README 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.
[WIP] initial code commit 2015-07-11 03:59:39 +02:00
Update LICENSE and README 2017-06-21 10:26:39 +02:00			`## Versioning`
[WIP] initial code commit 2015-07-11 03:59:39 +02:00
Update LICENSE and README 2017-06-21 10:26:39 +02:00			`amphp/file` follows the [semver](http://semver.org/) semantic versioning specification like all other `amphp` packages.

			`## Security`

			If you discover any security related issues, please email [`me@kelunik.com`](mailto:me@kelunik.com) instead of using the issue tracker.
Update for amp/1, remove descriptor handles 2015-07-30 15:07:01 +02:00
Update LICENSE and README 2017-06-21 10:26:39 +02:00			`## License`
Update for amp/1, remove descriptor handles 2015-07-30 15:07:01 +02:00
Link to parallel extension instead of pthreads (#48) 2020-05-03 18:59:52 +02:00			The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.