diff --git a/README.md b/README.md index 90febe8..6babf4e 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,11 @@ # Laravel FileStorage package +[![Latest Stable Version](https://img.shields.io/packagist/v/imahmood/laravel-file-storage.svg?style=flat-square)](https://packagist.org/packages/imahmood/laravel-file-storage) +[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/imahmood/laravel-file-storage/tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/imahmood/laravel-file-storage/actions?query=workflow%3Atests+branch%3Amain) +[![Total Downloads](https://img.shields.io/packagist/dt/imahmood/laravel-file-storage.svg?style=flat-square)](https://packagist.org/packages/imahmood/laravel-file-storage) +[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE) -## Installation -### 1. Install the package via Composer: - -``` -composer require imahmood/laravel-file-storage -``` - -### 2. Publish the configuration file -```bash -php artisan vendor:publish --provider="Imahmood\FileStorage\FileStorageServiceProvider" -``` +FileStorage is a Laravel package that simplifies the process of uploading and attaching files to models, +while also automating preview generation and image optimization. ## License - The MIT License (MIT). Please see [License File](LICENSE) for more information.