Skip to content

Commit 1cb953c

Browse files
Update README.md
1 parent d8add53 commit 1cb953c

File tree

1 file changed

+85
-2
lines changed

1 file changed

+85
-2
lines changed

README.md

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,85 @@
1-
Please check full documentation by the original link: https://github.com/UniSharp/laravel-filemanager
2-
Current Fork Includes a new feature of adding different thumb sizes based of the folder category
1+
<p align="center"><img src="https://unisharp.github.io/laravel-filemanager/images/logo_vertical_colored.png"></p>
2+
3+
<p align="center">
4+
<a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://poser.pugx.org/unisharp/laravel-filemanager/downloads"></a>
5+
<a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://img.shields.io/packagist/dm/unisharp/laravel-filemanager.svg"></a>
6+
<a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://img.shields.io/badge/stable-2.3.0-blue.svg"></a>
7+
<a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://poser.pugx.org/unisharp/laravel-filemanager/license"></a>
8+
<br>
9+
<a href="https://github.styleci.io/repos/39873788?branch=master"><img src="https://github.styleci.io/repos/39873788/shield?branch=master" alt="StyleCI"></a>
10+
<a target="_blank" href="https://scrutinizer-ci.com/g/UniSharp/laravel-filemanager/?branch=master"><img src="https://scrutinizer-ci.com/g/UniSharp/laravel-filemanager/badges/build.png?b=master"></a>
11+
<a target="_blank" href="https://scrutinizer-ci.com/g/UniSharp/laravel-filemanager/"><img src="https://scrutinizer-ci.com/g/UniSharp/laravel-filemanager/badges/quality-score.png?b=master"></a>
12+
<a target="_blank" href="https://codeclimate.com/github/UniSharp/laravel-filemanager/maintainability"><img src="https://api.codeclimate.com/v1/badges/e51f2ef8f4d9f97268db/maintainability" /></a>
13+
</p>
14+
15+
<p align="center">
16+
<a href="http://unisharp.github.io/laravel-filemanager/">Documents</a>
17+
18+
<a href="http://unisharp.github.io/laravel-filemanager/installation">Installation</a>
19+
20+
<a href="http://unisharp.github.io/laravel-filemanager/integration">Integration</a>
21+
22+
<a href="http://unisharp.github.io/laravel-filemanager/config">Config</a>
23+
24+
<a href="http://unisharp.github.io/laravel-filemanager/customization">Customization</a>
25+
26+
<a href="http://unisharp.github.io/laravel-filemanager/events">Events</a>
27+
28+
<a href="http://unisharp.github.io/laravel-filemanager/upgrade">Upgrade</a>
29+
30+
<a href="https://github.com/UniSharp/laravel-filemanager-example-5.3">Demo</a>
31+
32+
<a href="https://github.com/UniSharp/laravel-filemanager/wiki">FAQ</a>
33+
</p>
34+
35+
## Features
36+
* File upload and management
37+
* Uploading validation
38+
* Cropping and resizing of images
39+
* RWD user interface, and can be entirely customized
40+
* Supporting multiple files selection
41+
* Supporting cloud storages integration(with Laravel file system)
42+
* Multiple integration options:
43+
* WYSIWYG editors integration (CKEditor, TinyMCE, Summernote)
44+
* Standalone upload button
45+
* Iframe
46+
* Multi-user mode:
47+
* Shared folders: all users can upload and manage files
48+
* Private folders: dedicated folder for each user, only the owner can upload or manage files within
49+
* Customizable routes, middlewares, views, and folder path
50+
* Supports two categories: files and images. Each type works in different directory.
51+
* Supported locales : ar, az, bg, cs, de, el, en, es, eu, fa, fr, he, hu, id, it, ka, nl, pl, pt, pt-BR, ro, rs, ru, sk, sv, tr, uk, vi, zh-CN, zh-TW
52+
53+
## v2.0 backlogs
54+
55+
There are still some thing we need to do make this package better:
56+
* [x] Documents for v2.0.0
57+
* [ ] Events should pass object instead of only file path
58+
* [ ] Add more events for files and folders manipulation
59+
60+
We are also going to gain more integration like vue.js and Laravel Nova. Any PR is welcome!
61+
62+
![RWD demo](https://unisharp.github.io/laravel-filemanager/images/screenshots-v2.png)
63+
64+
## Maintainers
65+
66+
* [Stream](https://github.com/streamtw)
67+
* [Youchen Lee](https://github.com/youchenlee)
68+
* [Willem Leuverink](https://github.com/gwleuverink)
69+
70+
## Contributors
71+
72+
* All [@UniSharp](https://github.com/UniSharp) members
73+
* Security contributors (sort by alphabet)
74+
* Ayon Hasan (@lollipopl337)
75+
* Nathan
76+
* [@mdnazmulhasan27771](https://github.com/mdnazmulhasan27771) the designer of our logo. (Licensed CC BY 4.0)
77+
* [All contibutors](https://github.com/UniSharp/laravel-filemanager/graphs/contributors) from GitHub. (issues / PR)
78+
79+
## Credits
80+
81+
* [@taswler](https://github.com/tsawler) the original author of this package.
82+
* [@olivervogel](https://github.com/olivervogel) for the awesome [image library](https://github.com/Intervention/image).
83+
* SVG Loaders by [Sam](http://samherbert.net/svg-loaders/) (Licensed MIT)
84+
* Articles and videos which helped promoting this package.
85+
* All users and you.

0 commit comments

Comments
 (0)