Skip to content

Commit c2f93e3

Browse files
committed
Docs updates
1 parent e9f84f5 commit c2f93e3

File tree

13 files changed

+76
-111
lines changed

13 files changed

+76
-111
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Please check the following instructions before submitting a bug :
22
* Make sure you are using the latest version.
3-
* Make sure you read [installation](http://unisharp.github.io/laravel-filemanager/installation), [integration](http://unisharp.github.io/laravel-filemanager/integration), and [upgrade](http://unisharp.github.io/laravel-filemanager/upgrade) document.
3+
* Make sure you read [installation](http://unisharp.github.io/laravel-filemanager/installation), [integration](http://unisharp.github.io/laravel-filemanager/integration)
44

55
And provide the followings :
66
* Operating system :

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ about: Create a report to help us improve
66

77
Please check the following instructions before submitting a bug :
88
* Make sure you are using the latest version.
9-
* Make sure you read [installation](http://unisharp.github.io/laravel-filemanager/installation), [integration](http://unisharp.github.io/laravel-filemanager/integration), and [upgrade](http://unisharp.github.io/laravel-filemanager/upgrade) document.
9+
* Make sure you read [installation](http://unisharp.github.io/laravel-filemanager/installation), [integration](http://unisharp.github.io/laravel-filemanager/integration)
1010

1111
And provide the followings :
1212
* Operating system :

README.md

Lines changed: 22 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,36 @@
1-
<p align="center"><img src="https://unisharp.github.io/laravel-filemanager/images/logo_vertical_colored.png"></p>
2-
31
<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.0.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 target="_blank" href="https://travis-ci.org/UniSharp/laravel-filemanager"><img src="https://img.shields.io/travis/UniSharp/laravel-filemanager.svg"></a>
10-
<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>
11-
<a target="_blank" href="https://codeclimate.com/github/UniSharp/laravel-filemanager/maintainability"><img src="https://api.codeclimate.com/v1/badges/e51f2ef8f4d9f97268db/maintainability" /></a>
12-
<a target="_blank" href="https://packagist.org/packages/unisharp/laravel-filemanager"><img src="https://img.shields.io/badge/unstable-dev--master-orange.svg"></a>
2+
<a target="_blank" href="https://packagist.org/packages/mafftor/laravel-file-manager"><img src="https://poser.pugx.org/mafftor/laravel-file-manager/downloads"></a>
3+
<a target="_blank" href="https://packagist.org/packages/mafftor/laravel-file-manager"><img src="https://img.shields.io/packagist/dm/mafftor/laravel-file-manager.svg"></a>
4+
<a target="_blank" href="https://packagist.org/packages/mafftor/laravel-file-manager"><img src="https://img.shields.io/badge/stable-2.0.0-blue.svg"></a>
5+
<a target="_blank" href="https://packagist.org/packages/mafftor/laravel-file-manager"><img src="https://poser.pugx.org/mafftor/laravel-file-manager/license"></a>
136
</p>
147

8+
## This is advanced version of <a target="_blank" href="https://github.com/UniSharp/laravel-filemanager">UniSharp/laravel-filemanager</a> v2.0.0.
9+
### Now it will grow as single project. Your contributing is welcome here :)
10+
1511
<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>
12+
<a href="https://github.com/mafftor/laravel-file-manager/blob/master/docs/index.md">Documents</a>
1913
20-
<a href="http://unisharp.github.io/laravel-filemanager/integration">Integration</a>
14+
<a href="https://github.com/mafftor/laravel-file-manager/blob/master/docs/installation.md">Installation</a>
2115
22-
<a href="http://unisharp.github.io/laravel-filemanager/config">Config</a>
16+
<a href="https://github.com/mafftor/laravel-file-manager/blob/master/docs/integration.md">Integration</a>
2317
24-
<a href="http://unisharp.github.io/laravel-filemanager/customization">Customization</a>
18+
<a href="https://github.com/mafftor/laravel-file-manager/blob/master/docs/config.md">Config</a>
2519
26-
<a href="http://unisharp.github.io/laravel-filemanager/events">Events</a>
20+
<a href="https://github.com/mafftor/laravel-file-manager/blob/master/docs/customization.md">Customization</a>
2721
28-
<a href="http://unisharp.github.io/laravel-filemanager/upgrade">Upgrade</a>
22+
<a href="https://github.com/mafftor/laravel-file-manager/blob/master/docs/events.md">Events</a>
2923
30-
<a href="https://github.com/UniSharp/laravel-filemanager-example-5.3">Demo</a>
24+
<a href="https://github.com/mafftor/laravel-file-manager/blob/master/docs/security.md">Security</a>
3125
32-
<a href="https://github.com/UniSharp/laravel-filemanager/wiki">FAQ</a>
26+
<a href="https://github.com/mafftor/laravel-file-manager/blob/master/docs/contribution.md">Contribution</a>
3327
</p>
3428

35-
## v2.0 progress
36-
🎉 Finally v2.0.0 has been released! 🎉
37-
38-
These are primary features of this update:
39-
* Redesigned RWD user interface.
40-
* Supporting multiple files selection.
41-
* Supporting cloud storages integration(with Laravel file system).
42-
* Refactored code and increased test coverage.
43-
44-
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.
29+
##These our primary features:
30+
* RWD user interface.
31+
* multiple files selection.
32+
* cloud storages integration(with Laravel file system).
33+
* code and increased test coverage.
4534

4635
There are still some thing we need to do make this package better:
4736
* [ ] Documents for v2.0.0
@@ -56,6 +45,7 @@ We are also going to gain more integration like vue.js and Laravel Nova. Any PR
5645

5746
### Developers / Maintainers
5847

48+
* [Mafftor](https://github.com/mafftor)
5949
* [Stream](https://github.com/g0110280)
6050
* [@gwleuverink](https://github.com/gwleuverink)
6151
* All [@UniSharp](https://github.com/UniSharp) members
@@ -64,6 +54,7 @@ We are also going to gain more integration like vue.js and Laravel Nova. Any PR
6454

6555
* [All contibutors](https://github.com/UniSharp/laravel-filemanager/graphs/contributors) from GitHub. (issues / PR)
6656
* [@taswler](https://github.com/tsawler) the original author of this package.
57+
* [@UniSharp](https://github.com/UniSharp) the second author of this package.
6758
* Nathan for providing security suggestions.
6859
* [@mdnazmulhasan27771](https://github.com/mdnazmulhasan27771) the designer of our logo. (Licensed CC BY 4.0)
6960

docs/_config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ theme: jekyll-theme-cayman
33
# Setup
44
title: Laravel File Manager
55
description: It's like Dropbox for your Laravel app.
6-
google_analytics: UA-92410814-4
6+
google_analytics:
77

88
# About/contact
99
author:
10-
name: UniSharp
11-
url: https://github.com/UniSharp
10+
name: Mafftor
11+
url: https://github.com/mafftor

docs/_layouts/default.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,13 +102,12 @@ <h2 class="project-tagline">{{ site.description | default: site.github.project_t
102102
</div>
103103

104104
<nav id="nav">
105-
<span><a href="/laravel-filemanager">Home</a></span>
105+
<span><a href="/laravel-file-manager">Home</a></span>
106106
<span><a href="installation">Installation</a></span>
107107
<span><a href="integration">Integration</a></span>
108108
<span><a href="config">Config</a></span>
109109
<span><a href="customization">Customization</a></span>
110110
<span><a href="events">Events</a></span>
111-
<span><a href="upgrade">Upgrade</a></span>
112111
<span><a href="contribution">Contribution</a></span>
113112
<span><a href="security">Security</a></span>
114113
</nav>

docs/contribution.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## Steps to contribute
2-
1. Fork [unisharp/laravel-filemanager](https://github.com/UniSharp/laravel-filemanager) from GitHub.
2+
1. Fork [mafftor/laravel-file-manager](https://github.com/mafftor/laravel-file-manager) from GitHub.
33
1. Run commands below:
44

55
```
6-
git clone [email protected]:UniSharp/laravel-filemanager-example-5.3.git
6+
git clone [email protected]:unisharp/laravel-filemanager-example-5.3.git
77
cd laravel-filemanager-example-5.3
8-
composer require unisharp/laravel-filemanager:dev-master
8+
composer require mafftor/laravel-file-manager:dev-master
99
make init
1010
```
11-
1. Edit codes in `vendor/unisharp/laravel-filemanager`
11+
1. Edit codes in `vendor/mafftor/laravel-file-manager`
1212
1. Push your changes to your fork.
13-
1. Send a pull request to [unisharp/laravel-filemanager](https://github.com/UniSharp/laravel-filemanager).
13+
1. Send a pull request to [mafftor/laravel-file-manager](https://github.com/mafftor/laravel-file-manager).

docs/customization.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
Create route group to wrap package routes.
55

66
```php
7-
Route::group(['prefix' => 'laravel-filemanager', 'middleware' => ['web', 'auth']], function () {
8-
\UniSharp\LaravelFilemanager\Lfm::routes();
7+
Route::group(['prefix' => 'laravel-file-manager', 'middleware' => ['web', 'auth']], function () {
8+
\Mafftor\LaravelFileManager\Lfm::routes();
99
});
1010
```
1111

@@ -35,13 +35,13 @@
3535
```
3636

3737
## Views
38-
Copy views to `resources/views/vendor/unisharp/laravel-filemanager/` :
38+
Copy views to `resources/views/vendor/mafftor/laravel-file-manager/` :
3939

4040
```bash
4141
php artisan vendor:publish --tag=lfm_view
4242
```
4343

4444
## Translations
4545

46-
1. Copy `vendor/unisharp/laravel-filemanager/src/lang/en` to `/resources/lang/vendor/laravel-filemanager/<YOUR LANGUAGE>/lfm.php`.
46+
1. Copy `vendor/mafftor/laravel-file-manager/src/lang/en` to `/resources/lang/vendor/laravel-file-manager/<YOUR LANGUAGE>/lfm.php`.
4747
1. Edit the file as you please.

docs/events.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
## List of events
2-
* UniSharp\LaravelFilemanager\Events\ImageIsUploading
3-
* UniSharp\LaravelFilemanager\Events\ImageWasUploaded
4-
* UniSharp\LaravelFilemanager\Events\ImageIsRenaming
5-
* UniSharp\LaravelFilemanager\Events\ImageWasRenamed
6-
* UniSharp\LaravelFilemanager\Events\ImageIsDeleting
7-
* UniSharp\LaravelFilemanager\Events\ImageWasDeleted
8-
* UniSharp\LaravelFilemanager\Events\FolderIsRenaming
9-
* UniSharp\LaravelFilemanager\Events\FolderWasRenamed
10-
* UniSharp\LaravelFilemanager\Events\ImageIsResizing
11-
* UniSharp\LaravelFilemanager\Events\ImageWasResized
12-
* UniSharp\LaravelFilemanager\Events\ImageIsCropping
13-
* UniSharp\LaravelFilemanager\Events\ImageWasCropped
2+
* Mafftor\LaravelFileManager\Events\ImageIsUploading
3+
* Mafftor\LaravelFileManager\Events\ImageWasUploaded
4+
* Mafftor\LaravelFileManager\Events\ImageIsRenaming
5+
* Mafftor\LaravelFileManager\Events\ImageWasRenamed
6+
* Mafftor\LaravelFileManager\Events\ImageIsDeleting
7+
* Mafftor\LaravelFileManager\Events\ImageWasDeleted
8+
* Mafftor\LaravelFileManager\Events\FolderIsRenaming
9+
* Mafftor\LaravelFileManager\Events\FolderWasRenamed
10+
* Mafftor\LaravelFileManager\Events\ImageIsResizing
11+
* Mafftor\LaravelFileManager\Events\ImageWasResized
12+
* Mafftor\LaravelFileManager\Events\ImageIsCropping
13+
* Mafftor\LaravelFileManager\Events\ImageWasCropped
1414

1515

1616
## How to use
17-
* Sample code : [laravel-filemanager-demo-events](https://github.com/UniSharp/laravel-filemanager-demo-events)
17+
* Sample code : [laravel-filemanager-demo-events](https://github.com/unisharp/laravel-filemanager-demo-events)
1818
* To use events you can add a listener to listen to the events.
1919

2020
Snippet for `EventServiceProvider`

docs/index.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
[![Latest Stable Version](https://poser.pugx.org/unisharp/laravel-filemanager/v/stable)](https://packagist.org/packages/unisharp/laravel-filemanager)
2-
[![Total Downloads](https://poser.pugx.org/unisharp/laravel-filemanager/downloads)](https://packagist.org/packages/unisharp/laravel-filemanager)
3-
[![License](https://poser.pugx.org/unisharp/laravel-filemanager/license)](https://packagist.org/packages/unisharp/laravel-filemanager)
4-
5-
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)
1+
[![Latest Stable Version](https://poser.pugx.org/mafftor/laravel-file-manager/v/stable)](https://packagist.org/packages/mafftor/laravel-file-manager)
2+
[![Total Downloads](https://poser.pugx.org/mafftor/laravel-file-manager/downloads)](https://packagist.org/packages/mafftor/laravel-file-manager)
3+
[![License](https://poser.pugx.org/mafftor/laravel-file-manager/license)](https://packagist.org/packages/mafftor/laravel-file-manager)
64

75
## Features
86
* CKEditor and TinyMCE integration

docs/installation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
1. Run these lines
1111

1212
```bash
13-
composer require unisharp/laravel-filemanager
13+
composer require mafftor/laravel-file-manager
1414
php artisan vendor:publish --tag=lfm_config
1515
php artisan vendor:publish --tag=lfm_public
1616
php artisan storage:link
@@ -22,7 +22,7 @@
2222
1. Install package
2323

2424
```bash
25-
composer require unisharp/laravel-filemanager
25+
composer require mafftor/laravel-file-manager
2626
```
2727

2828
1. (optional) Edit `config/app.php` :
@@ -32,7 +32,7 @@
3232
Add service providers
3333

3434
```php
35-
UniSharp\LaravelFilemanager\LaravelFilemanagerServiceProvider::class,
35+
Mafftor\LaravelFileManager\LaravelFilemanagerServiceProvider::class,
3636
Intervention\Image\ImageServiceProvider::class,
3737
```
3838

@@ -70,10 +70,10 @@
7070
1. Edit `APP_URL` in `.env`.
7171
7272
## Installing alpha version
73-
* Run `composer require unisharp/laravel-filemanager:dev-master` to get the latest developer version.
73+
* Run `composer require mafftor/laravel-file-manager:dev-master` to get the latest developer version.
7474
7575
## What's next
7676

77-
1. Check the [integration document](http://unisharp.github.io/laravel-filemanager/integration) to see how to apply this package.
77+
1. Check the [integration document](https://github.com/mafftor/laravel-file-manager/blob/master/docs/integration.md) to see how to apply this package.
7878

79-
1. Check the [config document](http://unisharp.github.io/laravel-filemanager/config) to discover the flexibility of this package.
79+
1. Check the [config document](https://github.com/mafftor/laravel-file-manager/blob/master/docs/config.md) to discover the flexibility of this package.

0 commit comments

Comments
 (0)