update readme

Author: streamtw

README.md

@@ -4,12 +4,14 @@
 
  * Fork from [tsawler/laravel-filemanager](http://packalyst.com/packages/package/tsawler/laravel-filemanager)
  * support public and private folders for multi users
- * customizable views and routes
+ * customizable views, routes and middlewares
  * supported locales : en, fr(not completed yet), zh-TW, zh-CN
 
 ## Requirements
 
-This package requires [intervention/image](https://github.com/Intervention/image), in order to make thumbs, crop and resize images.
+ * php >= 5.5
+ * Laravel 5 (working to support Laravel 4)
+ * requires [intervention/image](https://github.com/Intervention/image)(to make thumbs, crop and resize images).
 
 ## Installation
 
@@ -38,9 +40,10 @@ This package requires [intervention/image](https://github.com/Intervention/image
 
     ```
         php artisan vendor:publish --tag=lfm_config
+        php artisan vendor:publish --tag=lfm_public
     ```
     
-1. Fill user_field with a column name in users table as user's slug in `config/lfm.php` :
+1. Set user's folder name (with a column name in users table) in `config/lfm.php` :
  
     ```
         'user_field' => 'name',
@@ -70,31 +73,46 @@ This package requires [intervention/image](https://github.com/Intervention/image
 
 1. Ensure that the files & images directories are writable by your web server
 
-## Customization
+## Setting config
     
-1. To use your own route, edit config/lfm.php :
+In `config/lfm.php` :
 
     ```php
-        'use_package_routes' => false,
-    ```
+        'rename_file'        => true,
+        // true : files will be renamed as uniqid
+        // false : files will remain original names
 
-1. To disable multi-user mechanism, dit config/lfm.php :
+        'use_package_routes' => true,
+        // set this to false to customize route for file manager
 
-    ```php
-        'allow_multi_user' => false,
-    ```
-    
-1. To specify upload directory, edit config/lfm.php :
+        'middlewares'        => ['auth'],
+        // determine middlewares that apply to all file manager routes
 
-    ```php
-        'images_dir' => 'public/photos/',
-        'images_url' => '/photos/',
+        'allow_multi_user'   => true,
+        // true : user can upload files to shared folder and their own folder
+        // false : all files are put together in shared folder
+
+        'user_field'         => 'name',
+        // determine which column of users table will be used as user's folder name
+
+        'shared_folder_name' => 'shares',
+        // the name of shared folder
 
-        'files_dir'  => 'public/files/',
-        'files_url'  => '/files/',
+        'thumb_folder_name'  => 'thumbs',
+        // the name of thumb folder
+
+        'images_dir'         => 'public/photos/',
+        'images_url'         => '/photos/',
+        // path and url of images
+
+        'files_dir'          => 'public/files/',
+        'files_url'          => '/files/',
+        // path and url of files
     ```
 
-1. If the route is changed, make sure `filebrowserImageBrowseUrl` is correspond to your route :
+## Customization
+
+1. If the route is changed, make sure urls below is correspond to your route :
 
     ```javascript
         <script>
@@ -107,4 +125,8 @@ This package requires [intervention/image](https://github.com/Intervention/image
     
     And be sure to include the `?type=Images` or `?type=Files` parameter.
     
-1. To customize the views, copy file from `vendor/unisharp/laravel-filemanager/src/views` to `resources/views/vendor/laravel-filemanager`.
+1. To customize the views :
+
+    ```
+        cp vendor/unisharp/laravel-filemanager/src/views/* resources/views/vendor/laravel-filemanager/
+    ```

src/config/lfm.php

@@ -1,52 +1,52 @@
 <?php
 
 return [
+    'rename_file'        => true,
+
     'use_package_routes' => true,
 
-    'allow_multi_user'   => true,
+    'middlewares'        => ['auth'],
 
-    'rename_file'        => true,
+    'allow_multi_user'   => true,
 
     'user_field'         => 'name',
 
     'shared_folder_name' => 'shares',
     'thumb_folder_name'  => 'thumbs',
 
-    'middlewares'        => ['auth'],
-
     'images_dir'         => 'public/photos/',
     'images_url'         => '/photos/',
 
     'files_dir'          => 'public/files/',
     'files_url'          => '/files/',
 
     'file_type_array'         => [
-        "pdf"  => "Adobe Acrobat",
-        "docx" => "Microsoft Word",
-        "docx" => "Microsoft Word",
-        "xls"  => "Microsoft Excel",
-        "xls"  => "Microsoft Excel",
-        "zip"  => 'Archive',
-        "gif"  => 'GIF Image',
-        "jpg"  => 'JPEG Image',
-        "jpeg" => 'JPEG Image',
-        "png"  => 'PNG Image',
-        "ppt"  => 'Microsoft PowerPoint',
-        "pptx" => 'Microsoft PowerPoint',
+        'pdf'  => 'Adobe Acrobat',
+        'docx' => 'Microsoft Word',
+        'docx' => 'Microsoft Word',
+        'xls'  => 'Microsoft Excel',
+        'xls'  => 'Microsoft Excel',
+        'zip'  => 'Archive',
+        'gif'  => 'GIF Image',
+        'jpg'  => 'JPEG Image',
+        'jpeg' => 'JPEG Image',
+        'png'  => 'PNG Image',
+        'ppt'  => 'Microsoft PowerPoint',
+        'pptx' => 'Microsoft PowerPoint',
     ],
 
     'file_icon_array'         => [
-        "pdf"  => "fa-file-pdf-o",
-        "docx" => "fa-file-word-o",
-        "docx" => "fa-file-word-o",
-        "xls"  => "fa-file-excel-o",
-        "xls"  => "fa-file-excel-o",
-        "zip"  => 'fa-file-archive-o',
-        "gif"  => 'fa-file-image-o',
-        "jpg"  => 'fa-file-image-o',
-        "jpeg" => 'fa-file-image-o',
-        "png"  => 'fa-file-image-o',
-        "ppt"  => 'fa-file-powerpoint-o',
-        "pptx" => 'fa-file-powerpoint-o',
+        'pdf'  => 'fa-file-pdf-o',
+        'docx' => 'fa-file-word-o',
+        'docx' => 'fa-file-word-o',
+        'xls'  => 'fa-file-excel-o',
+        'xls'  => 'fa-file-excel-o',
+        'zip'  => 'fa-file-archive-o',
+        'gif'  => 'fa-file-image-o',
+        'jpg'  => 'fa-file-image-o',
+        'jpeg' => 'fa-file-image-o',
+        'png'  => 'fa-file-image-o',
+        'ppt'  => 'fa-file-powerpoint-o',
+        'pptx' => 'fa-file-powerpoint-o',
     ],
 ];