Skip to content

Commit 36a54e9

Browse files
authored
docs: quick installation
1 parent 2624eed commit 36a54e9

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ return DataTables::make(User::all())->toJson();
5858
## Requirements
5959
- [PHP >= 8.2](http://php.net/)
6060
- [Laravel Framework](https://github.com/laravel/framework)
61-
- [jQuery DataTables](http://datatables.net/)
61+
- [DataTables](http://datatables.net/)
6262

6363
## Documentations
6464

@@ -89,13 +89,21 @@ return DataTables::make(User::all())->toJson();
8989

9090
## Quick Installation
9191

92+
### Option 1: Install all DataTables libraries
93+
94+
```bash
95+
composer require yajra/laravel-datatables:"^11"
96+
```
97+
98+
### Option 2: Install only this library
99+
92100
```bash
93101
composer require yajra/laravel-datatables-oracle:"^11"
94102
```
95103

96104
#### Service Provider & Facade (Optional on Laravel 5.5+)
97105

98-
Register provider and facade on your `config/app.php` file.
106+
Register the provider and facade on your `config/app.php` file.
99107
```php
100108
'providers' => [
101109
...,
@@ -120,11 +128,12 @@ And that's it! Start building out some awesome DataTables!
120128

121129
To enable debugging mode, just set `APP_DEBUG=true` and the package will include the queries and inputs used when processing the table.
122130

123-
**IMPORTANT:** Please make sure that APP_DEBUG is set to false when your app is on production.
131+
> [!IMPORTANT]
132+
> Please ensure that the `APP_DEBUG` config is set to false when your app is in production.
124133
125134
## PHP ARTISAN SERVE BUG
126135

127-
Please avoid using `php artisan serve` when developing with the package.
136+
Please avoid using `php artisan serve` when developing the package.
128137
There are known bugs when using this where Laravel randomly returns a redirect and 401 (Unauthorized) if the route requires authentication and a 404 NotFoundHttpException on valid routes.
129138

130139
It is advised to use [Homestead](https://laravel.com/docs/5.4/homestead) or [Valet](https://laravel.com/docs/5.4/valet) when working with the package.
@@ -135,7 +144,7 @@ Please see [CONTRIBUTING](https://github.com/yajra/laravel-datatables/blob/maste
135144

136145
## Security
137146

138-
If you discover any security related issues, please email [aqangeles@gmail.com](mailto:aqangeles@gmail.com) instead of using the issue tracker.
147+
If you discover any security-related issues, please email [aqangeles@gmail.com](mailto:aqangeles@gmail.com) instead of using the issue tracker.
139148

140149
## Credits
141150

0 commit comments

Comments
 (0)