update documents for v2.0.0

Author: streamtw

.gitignore

@@ -2,3 +2,4 @@
 composer.lock
 /docs/Gemfile.lock
 /docs/_site
+.DS_Store

README.md

@@ -1,14 +1,15 @@
 <p align="center"><img src="https://unisharp.github.io/laravel-filemanager/images/logo_vertical_colored.png"></p>
 
 <p align="center">
-  <a target="_blank" href="https://travis-ci.org/UniSharp/laravel-filemanager"><img src="https://img.shields.io/travis/UniSharp/laravel-filemanager.svg"></a>
   <a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://poser.pugx.org/unisharp/laravel-filemanager/downloads"></a>
   <a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://img.shields.io/packagist/dm/unisharp/laravel-filemanager.svg"></a>
+  <a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://img.shields.io/badge/stable-2.0.0-blue.svg"></a>
+  <a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://poser.pugx.org/unisharp/laravel-filemanager/license"></a>
+  <br>
+  <a target="_blank" href="https://travis-ci.org/UniSharp/laravel-filemanager"><img src="https://img.shields.io/travis/UniSharp/laravel-filemanager.svg"></a>
   <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>
   <a target="_blank" href="https://codeclimate.com/github/UniSharp/laravel-filemanager/maintainability"><img src="https://api.codeclimate.com/v1/badges/e51f2ef8f4d9f97268db/maintainability" /></a>
-  <a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://img.shields.io/badge/unstable-v2.0.0--alpha8-orange.svg"></a>
-  <a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://poser.pugx.org/unisharp/laravel-filemanager/v/stable"></a>
-  <a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://poser.pugx.org/unisharp/laravel-filemanager/license"></a>
+  <a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://img.shields.io/badge/unstable-dev-master-orange.svg"></a>
 </p>
 
 <p align="center">
@@ -31,63 +32,25 @@
   <a href="https://github.com/UniSharp/laravel-filemanager/wiki">FAQ</a>
 </p>
 
-## Installing alpha version
-The alpha version of `v2.0` contains support for cloud storage and fresh new UI with RWD.
-
- * Run `composer require unisharp/laravel-filemanager:dev-master` to get the latest code.
- * Run `composer require unisharp/laravel-filemanager:v2.0.0-alpha8` to get the latest release of alpha version.
+![RWD demo](https://unisharp.github.io/laravel-filemanager/images/screenshots-v2.png)
 
 ## v2.0 progress
-* [x] (done) Unit test
-* [x] (done) Integrate with Laravel Storage
-* [x] (done) Multiple selection
-* [x] (done) Responsive design
-* [x] (done) Config refactoring
-* [x] (done) JSON APIs
-* [x] (done) Move to folder function
-* [x] (done) Applying MIME icon generator
-* [x] (done) Refactor floating action buttons
-* [x] (done) Configurable disk of storage
-* [x] (done) Bootstrap 4 support
-* [x] (done) Remove bootbox
-* [ ] Documents for v2.0
-* [x] (done) Resize function RWD refactor
-* [ ] ConfigHandler should overwrite most configs
-* [ ] Events should pass object instead of only file path
-* [ ] Add more events for files and folders manipulation
-
-## Documents of V1
-https://github.com/UniSharp/laravel-filemanager/tree/v1/docs
+🎉 Finally v2.0.0 has been released! 🎉
 
-## Errors with namespace
-We have changed namespace from `Unisharp` to `UniSharp`, and change the first character of every namespace into capital.
+These are primary features of this update:
+* Redesigned RWD user interface.
+* Supporting multiple files selection.
+* Supporting cloud storages integration(with Laravel file system).
+* Refactored code and increased test coverage.
 
-If you are updating this package and encounter any errors like `Class not found`, please remove this package entirely and reinstall again.
+Although it is not perfect enough, we decided to release it. Now users who want the above features won't need to install alpha versions anymore.
 
-## v1.8 released
- * Please follow the intructions in [upgrade document](https://unisharp.github.io/laravel-filemanager/upgrade).
- * Important changes :
-   * Fix Windows compatibility (utf-8 file names and folder names).
-   * New feature : Copy & Crop. Thanks [gwleuverink](https://github.com/gwleuverink).
-   * [Config document](https://unisharp.github.io/laravel-filemanager/config) is refactored.
-
-## Security
-
-It is important to note that if you use your own routes **you must protect your routes to Laravel-Filemanager in order to prevent unauthorized uploads to your server**. Fortunately, Laravel makes this very easy.
-
-If, for example, you want to ensure that only logged in users have the ability to access the Laravel-Filemanager, simply wrap the routes in a group, perhaps like this:
-
-```php
-Route::group(['middleware' => 'auth'], function () {
-    Route::get('/laravel-filemanager', '\UniSharp\LaravelFilemanager\Controllers\LfmController@show');
-    Route::post('/laravel-filemanager/upload', '\UniSharp\LaravelFilemanager\Controllers\UploadController@upload');
-    // list all lfm routes here...
-});
-```
-
-This approach ensures that only authenticated users have access to the Laravel-Filemanager. If you are using Middleware or some other approach to enforce security, modify as needed.
+There are still some thing we need to do make this package better:
+* [ ] Documents for v2.0.0
+* [ ] Events should pass object instead of only file path
+* [ ] Add more events for files and folders manipulation
 
-**If you use the laravel-filemanager default route, make sure the `auth` middleware (set in config/lfm.php) is enabled and functional**.
+We are also going to gain more integration like vue.js and Laravel Nova. Any PR is welcome!
 
 ## Contributors & Credits
 

docs/_layouts/default.html

@@ -110,6 +110,7 @@ <h2 class="project-tagline">{{ site.description | default: site.github.project_t
         <span><a href="events">Events</a></span>
         <span><a href="upgrade">Upgrade</a></span>
         <span><a href="contribution">Contribution</a></span>
+        <span><a href="security">Security</a></span>
       </nav>
     </section>
 

docs/images/screenshots-v2.png

@@ -2,6 +2,8 @@
 [![Total Downloads](https://poser.pugx.org/unisharp/laravel-filemanager/downloads)](https://packagist.org/packages/unisharp/laravel-filemanager)
 [![License](https://poser.pugx.org/unisharp/laravel-filemanager/license)](https://packagist.org/packages/unisharp/laravel-filemanager)
 
+This is the document of v2 version, v1 document can be found here: [https://github.com/UniSharp/laravel-filemanager/tree/v1/docs](https://github.com/UniSharp/laravel-filemanager/tree/v1/docs)
+
 ## Features
  * CKEditor and TinyMCE integration
  * Standalone button
@@ -12,18 +14,14 @@
  * Supports two types : files and images. Each type works in different directory.
  * Supported locales : ar, bg, de, el, en, es, fa, fr, it, he, hu, nl, pl, pt-BR, pt_PT, ro, ru, sv, tr, zh-CN, zh-TW
 
-PR is welcome!
+PRs are welcome!
 
 ## Screenshots
 > Standalone button :
 
 ![Standalone button demo](https://unisharp.github.io/laravel-filemanager/images/lfm01.png)
 
-> Grid view :
-
-![Grid view demo](https://unisharp.github.io/laravel-filemanager/images/lfm02.png)
-
-> List view :
+> Responsive design :
 
-![List view demo](https://unisharp.github.io/laravel-filemanager/images/lfm03.png)
+![RWD demo](https://unisharp.github.io/laravel-filemanager/images/screenshots-v2.png)
 

docs/index.md

@@ -6,11 +6,23 @@
  * Laravel 5
  * requires [intervention/image](https://github.com/Intervention/image) (to make thumbs, crop and resize images).
 
-## Installation
+## TL;DR
+1. Run these lines
+
+    ```bash
+    composer require unisharp/laravel-filemanager
+    php artisan vendor:publish --tag=lfm_config
+    php artisan vendor:publish --tag=lfm_public
+    php artisan storage:link
+    ```
+
+1. Edit `APP_URL` in `.env`.
+
+## Full Installation Guide
 1. Install package
 
     ```bash
-    composer require unisharp/laravel-filemanager:~1.8
+    composer require unisharp/laravel-filemanager
     ```
 
 1. (optional) Edit `config/app.php` :
@@ -57,6 +69,9 @@
 
 1. Edit `APP_URL` in `.env`.
 
+## Installing alpha version
+ * Run `composer require unisharp/laravel-filemanager:dev-master` to get the latest developer version.
+
 ## What's next
 
 1. Check the [integration document](http://unisharp.github.io/laravel-filemanager/integration) to see how to apply this package.

docs/installation.md

@@ -0,0 +1,15 @@
+## Security
+
+It is important to note that if you use your own routes **you must protect your routes to Laravel-Filemanager in order to prevent unauthorized uploads to your server**. Fortunately, Laravel makes this very easy.
+
+If, for example, you want to ensure that only logged in users have the ability to access the Laravel-Filemanager, simply wrap the routes in a group, perhaps like this:
+
+```php
+Route::group(['middleware' => 'auth'], function () { // auth middleware is important!
+    \UniSharp\LaravelFilemanager\Lfm::routes();
+});
+```
+
+This approach ensures that only authenticated users have access to the Laravel-Filemanager. If you are using Middleware or some other approach to enforce security, modify as needed.
+
+**If you use the laravel-filemanager default route, make sure the `auth` middleware (set in config/lfm.php) is enabled and functional**.