diff --git a/LICENSE b/LICENSE index fe1529a..8d75eb6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2015 amphp +Copyright (c) 2015-2017 amphp Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 9ceed17..8914dad 100644 --- a/README.md +++ b/README.md @@ -2,35 +2,37 @@ [![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) -![Unstable](https://img.shields.io/badge/api-unstable-orange.svg?style=flat-square) +![Stable](https://img.shields.io/badge/v0.2-stable-orange.svg?style=flat-square) ![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). -`amphp/file` is a non-blocking filesystem library for use with the [`amp`](https://github.com/amphp/amp) -concurrency framework. +## Installation -**Dependencies** - -- PHP 5.5+ -- [eio](https://pecl.php.net/package/eio) -- [php-uv](https://github.com/bwoebi/php-uv) (experimental, requires PHP7) - -`amphp/file` 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 `amphp/file` in production -without pecl/eio or php-uv is **NOT** recommended. - -**Current Version** - -`amphp/file` is currently pre-alpha software and has no tagged releases. Your mileage may vary. - -**Installation** +This package can be installed as a [Composer](https://getcomposer.org/) dependency. ```bash -$ composer require amphp/file:dev-master +composer require amphp/file ``` -**TODO** +## Optional Extension Backends -- seek/read/write to/from specific offsets on open file handles -- expose API for receiving notifications when files/directories are modified \ No newline at end of file +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) + - [pthreads](https://github.com/krakjoe/pthreads) + +`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. \ No newline at end of file