1
0
mirror of https://github.com/danog/file.git synced 2024-11-26 11:54:54 +01:00
file/README.md

30 lines
1.0 KiB
Markdown
Raw Normal View History

2015-07-18 21:06:19 +02:00
# amp/fs
2015-07-19 18:30:45 +02:00
[![Build Status](https://travis-ci.org/amphp/fs.svg?branch=master)](https://travis-ci.org/amphp/fs)
[![Coverage Status](https://coveralls.io/repos/amphp/fs/badge.svg?branch=master&service=github)](https://coveralls.io/github/amphp/fs?branch=master)
2015-07-18 21:06:19 +02:00
![Unstable](https://img.shields.io/badge/pre_alpha-unstable-orange.svg)
2015-07-11 03:59:39 +02:00
`amp/fs` is a non-blocking filesystem manipulation library for use with the
2015-07-19 19:18:01 +02:00
[amp](https://github.com/amphp/amp) concurrency framework.
2015-07-11 03:59:39 +02:00
**Dependencies**
- PHP 5.5+
2015-07-18 21:06:19 +02:00
- [eio](https://pecl.php.net/package/eio)
- [php-uv](https://github.com/bwoebi/php-uv) (experimental, requires PHP7)
2015-07-11 03:59:39 +02:00
2015-07-19 19:18:01 +02:00
`amp/fs` works out of the box without any PHP extensions but it does so using
blocking functions. This capability only exists to simplify development across
environments where extensions may not be present. Using `amp/fs` in production
without pecl/eio or php-uv is **NOT** recommended.
2015-07-11 03:59:39 +02:00
**Current Version**
2015-07-18 21:06:19 +02:00
`amp/fs` is currently pre-alpha software and has no tagged releases. Your mileage may vary.
2015-07-11 03:59:39 +02:00
**Installation**
```bash
2015-07-18 21:06:19 +02:00
$ composer require amphp/fs
2015-07-11 03:59:39 +02:00
```