Skip to content

Commit f86df9d

Browse files
Change the readme file
1 parent 9c9f857 commit f86df9d

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,13 @@
55
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/webplusmultimedia/filemanager/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/webplusmultimedia/filemanager/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
66
[![Total Downloads](https://img.shields.io/packagist/dt/webplusmultimedia/filemanager.svg?style=flat-square)](https://packagist.org/packages/webplusmultimedia/filemanager)
77

8-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
8+
Want to manage your files and directories in a file manager?
99

10-
## Support us
10+
This one is for you. Here is the file manager made with alpineJs, Livewire and Tailwind CSS for Laravel.
1111

12-
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/FileManager.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/FileManager)
12+
This is a simple one, just adding files and directories to a root directory(default is medias) in your public storage path. You can change it in the filemanager config file.
1313

14-
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
15-
16-
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
14+
[![img.png](https://i.postimg.cc/XvQ1M2gt/img.png)](https://postimg.cc/v1xtftkv)
1715

1816
## Installation
1917

@@ -23,14 +21,7 @@ You can install the package via composer:
2321
composer require webplusmultimedia/filemanager
2422
```
2523

26-
You can publish and run the migrations with:
27-
28-
```bash
29-
php artisan vendor:publish --tag="filemanager-migrations"
30-
php artisan migrate
31-
```
32-
33-
You can publish the config file with:
24+
You can publish the config file and change the root :
3425

3526
```bash
3627
php artisan vendor:publish --tag="filemanager-config"
@@ -40,20 +31,30 @@ This is the contents of the published config file:
4031

4132
```php
4233
return [
34+
'root' => 'medias',
4335
];
4436
```
4537

46-
Optionally, you can publish the views using
38+
Optionally, you can publish the views using, but not recommend cause failing at an future update
4739

4840
```bash
4941
php artisan vendor:publish --tag="filemanager-views"
5042
```
5143

5244
## Usage
53-
54-
```php
55-
$fileManager = new Webplusmultimedia\FileManager();
56-
echo $fileManager->echoPhrase('Hello, Webplusmultimedia!');
45+
For simple use in a blade view :
46+
```html
47+
<div class="py-12">
48+
<div class="max-w-7xl mx-auto sm:px-6 lg:px-8" aria->
49+
<div class="bg-white overflow-hidden shadow-sm sm:rounded-lg">
50+
<div class="p-6 text-gray-900 ">
51+
<h1 class="text-2xl uppercase font-bold mb-6">{{ __("Téléversement de fichiers") }}</h1>
52+
<!-- the livewire component -->
53+
<livewire:filemanager/>
54+
</div>
55+
</div>
56+
</div>
57+
</div>
5758
```
5859

5960
## Testing
@@ -76,8 +77,7 @@ Please review [our security policy](../../security/policy) on how to report secu
7677

7778
## Credits
7879

79-
- [webplusm](https://github.com/webplusmultimedia)
80-
- [All Contributors](../../contributors)
80+
- [Webplusm Multimedia](https://github.com/webplusmultimedia)
8181

8282
## License
8383

doc/img.png

116 KB
Loading

0 commit comments

Comments
 (0)