Skip to content

Commit c69e3b4

Browse files
authored
Updated readme
Specified Laravel 5.8 as the most recent compatible version. Specified the required service provider configuration for L 5.4 and under. Updated some texts
1 parent dfa34b3 commit c69e3b4

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

README.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Panic Help Desk
2-
This package is a ticketing system for [Laravel 5](https://laravel.com/) PHP framework based on [Kordy/Ticketit](https://github.com/thekordy/ticketit). It, of course, has [all ticketit features](https://github.com/thekordy/ticketit/wiki/v0.2-Features) and some new and useful ones: File attachments, ticket tags, calendar fields and a filters panel. It may be installed in any project based on Laravel 5.1 to 5.4. It has it's own routes, so it shouldn't affect other packages.
2+
This package is a ticketing system for [Laravel 5](https://laravel.com/) PHP framework based on [Kordy/Ticketit](https://github.com/thekordy/ticketit). We have kept almost [all ticketit features](https://github.com/thekordy/ticketit/wiki/v0.2-Features) and includes many other functionalities to bring you closer to any production environment, like file attachments, ticket tags, calendar fields and a filters panel. It may work in any Laravel app from version 5.1 to 5.8. It has it's own routes, so it shouldn't affect other packages.
33

44
## Table of contents
55

@@ -32,16 +32,9 @@ This ticketing system is actually mean to be used in a corporate support environ
3232
* We have included all required asset files in the package structure because we want it to be usable in our LAN even without working internet connection (think about IT corporate support)
3333

3434
#### Translations
35-
This package is multilingual. Current full covered languages are Catalan, English and Brazillian Portuguese.
36-
The following are other translations that come from Ticketit and are'nt up to date. A helping hand on any of them will be very welcome:
37-
* Armenian
38-
* Deutsch
39-
* Farsi
40-
* French
41-
* Hungarian
42-
* Italian
43-
* Russian
44-
* Spanish
35+
This package comes with Catalan, English and Brazillian Portuguese language files. For any of them you don't need to do anything: PanicHD will get your Laravel configuration.
36+
37+
You may also you may create your own language files. There are some outdated language files that come from Ticketit and can be a good starting point. We encourage you to make your own language files and publish them to share with other speakers.
4538

4639
#### A ticket step by step example
4740
1. A user registers a new ticket for a specific issue
@@ -96,7 +89,7 @@ This is a synopsis of the main PanicHD features. For detailed descriptions, exam
9689
## Installing
9790
### Requirements
9891
* [Laravel](https://laravel.com/) 5.1 or higher including:
99-
+ [Laravel auth](https://laravel.com/docs/5.3/authentication#introduction) with at least one user registered
92+
+ [Laravel auth](https://laravel.com/docs/master/authentication#authentication-quickstart) with at least one user registered
10093
+ Model App\User.php that uses users table. It is added with Laravel auth by default and PanicHD requires it to be there. It seems that some admin panels change it to App\Models\User.php or maybe other routes.
10194
+ Valid email configuration (Needed for PanicHD notification emails)
10295

@@ -114,7 +107,8 @@ If it's installed in the same Laravel project you want to install Panic Help Des
114107
### Installation steps
115108
1. Open a command line in the Laravel folder and type:
116109
`composer require panichd/panichd`
117-
2. Open config/app.php and in the "Providers" section, add:
110+
2. If you are using Laravel 5.4 or lower, you will have to add the service provider. In this case, Open config/app.php. In the "Providers" section, add:
111+
118112
`PanicHD\PanicHD\PanicHDServiceProvider::class,`
119113

120114
### Complete installation

0 commit comments

Comments
 (0)