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

35 lines
1.3 KiB
Markdown
Raw Normal View History

2015-07-30 16:10:53 +02:00
# filesystem
2015-07-18 21:06:19 +02:00
2015-07-30 16:10:53 +02:00
[![Build Status](https://img.shields.io/travis/amphp/filesystem/master.svg?style=flat-square)](https://travis-ci.org/amphp/filesystem)
[![CoverageStatus](https://img.shields.io/coveralls/amphp/filesystem/master.svg?style=flat-square)](https://coveralls.io/github/amphp/filesystem?branch=master)
![Unstable](https://img.shields.io/badge/api-unstable-orange.svg?style=flat-square)
![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)
2015-07-11 03:59:39 +02:00
2015-07-30 16:10:53 +02:00
`amphp/filesystem` is a non-blocking filesystem library for use with the [`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-30 16:10:53 +02:00
`amphp/filesystem` works out of the box without any PHP extensions but it does so using
2015-07-19 19:18:01 +02:00
blocking functions. This capability only exists to simplify development across
2015-07-30 16:10:53 +02:00
environments where extensions may not be present. Using `amphp/filesystem` in production
2015-07-19 19:18:01 +02:00
without pecl/eio or php-uv is **NOT** recommended.
2015-07-11 03:59:39 +02:00
**Current Version**
2015-07-30 16:10:53 +02:00
`amphp/filesystem` 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-30 16:10:53 +02:00
$ composer require amphp/filesystem:dev-master
2015-07-11 03:59:39 +02:00
```
**TODO**
- seek/read/write to/from specific offsets on open file handles