Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jimmy-JS committed May 10, 2020
1 parent e6f1935 commit 7c609f3
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ Rapidly Generate Simple Pdf Report on Laravel (Using [barryvdh/laravel-dompdf](h

This package provides a simple pdf, csv & excel report generators to speed up your workflow

## Version
| Version | Laravel Version | Php Version | Maatwebsite/Excel Ver | Feature
|------|---------|-------|--------|-------
| 1.0 | <= 5.6 | <=7.0 | ~2.1.0 | using `chunk()` to handle big data
| 1.1 | <= 5.6 | <=7.0 | ~2.1.0 | using `cursor()` to handle big data
| 2.0 | \>= 5.5 | ^7.0 | ^3.1 | Using new version of maatwebsite (v3.1)
Find the comparison between `chunk` and `cursor` in [here](https://qiita.com/ryo511/items/ebcd1c1b2ad5addc5c9d)

## Installation
Add package to your composer:

Expand All @@ -20,19 +28,6 @@ If you are running Laravel > 5.5 that's all you need to do. If you are using Lar

For more better speed on generating pdf report, I recommend you to use laravel snappy package. To using laravel snappy, you should install `wkhtmltopdf` to work with this package [(Jump to wkhtmltopdf installation)](#wkhtmltopdf-installation)

## Information

This package can use either `cursor` or `chunk` method (Eloquent / Query Builder) so it can handle big data faster than chunk and minimizing memory usage.

Method | On Version
--- | ---
chunk() | 1.0.*
cursor() | ^1.1.0

Find the comparison between `chunk` and `cursor` in [here](https://qiita.com/ryo511/items/ebcd1c1b2ad5addc5c9d)

Also, You can use `PdfReport`, `ExcelReport` or `CSVReport` facade for shorter code that already registered as an alias.

### Example Display PDF Code
```php
use PdfReport;
Expand Down

0 comments on commit 7c609f3

Please sign in to comment.