diff --git a/README.md b/README.md index e69de29..df30d79 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,23 @@ +# ImageFile + +ImageFile library contains ImageFile class that allows to create and save image files from base64 encoded strings. It's very useful for APIs written via Laravel framework. + +## Installation + +ImageFile requires [PHP](https://php.net) 7.1 and greater. +To get the latest version, simply require the project using [Composer](https://getcomposer.org): +```bash +$ composer require gevorgmelkumyan/image-file +``` + +## Usage + +Look at `examples/example.php` file. + +## Authors + +See the list of [contributors](https://github.com/gevorgmelkumyan/image-file/graphs/contributors) who participated in this project. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.