Skip to content

Commit 13805d7

Browse files
committed
update README.md
1 parent 1e17ac3 commit 13805d7

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Laravel FileStorage package
2+
23
[![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)
34
[![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)
45
[![Total Downloads](https://img.shields.io/packagist/dt/imahmood/laravel-file-storage.svg?style=flat-square)](https://packagist.org/packages/imahmood/laravel-file-storage)
@@ -7,5 +8,28 @@
78
FileStorage is a Laravel package that simplifies the process of uploading and attaching files to models,
89
while also automating preview generation and image optimization.
910

11+
## Features
12+
13+
- Easily upload and attach files to models.
14+
- Specify the storage disk dynamically using the `onDisk` method.
15+
- Automatically generate previews for images and PDFs and optimize images, improving user experience.
16+
17+
## Requirements
18+
19+
Before using this package, make sure your environment meets the following requirements:
20+
21+
- **PHP:** 8.1 or later.
22+
- **Extensions:** `ext-ffi` extension is required.
23+
- **System Packages:** `libvips42` library is necessary for image processing.
24+
25+
26+
## Documentation
27+
28+
* [Installation](docs/installation.md)
29+
* [Quick start](docs/quick-start.md)
30+
* [Getting a file URL](docs/getting-url.md)
31+
* [Methods](docs/methods.md)
32+
* [Events](docs/events.md)
33+
1034
## License
1135
The MIT License (MIT). Please see [License File](LICENSE) for more information.

0 commit comments

Comments
 (0)