Updated README
This commit is contained in:
23
README.md
23
README.md
@@ -2,6 +2,10 @@
|
||||
|
||||
Neat Livewire Charts for your Laravel projects.
|
||||
|
||||
### Preview
|
||||
|
||||

|
||||
|
||||
## Installation
|
||||
|
||||
You can install the package via composer:
|
||||
@@ -10,12 +14,31 @@ You can install the package via composer:
|
||||
composer require asantibanez/livewire-charts
|
||||
```
|
||||
|
||||
### Requirements
|
||||
|
||||
This package uses `Laravel Livewire v2` (https://laravel-livewire.com/) under the hood.
|
||||
|
||||
It also uses `Alpine Js` (https://github.com/alpinejs/alpine) for creating charts on the
|
||||
frontend using `Apex Charts` (https://apexcharts.com/)
|
||||
|
||||
NOTE: At the moment, `Apex Charts` is only supported for drawing charts.
|
||||
|
||||
Please make sure you include these dependencies before using this package.
|
||||
|
||||
## Usage
|
||||
|
||||
```blade
|
||||
<livewire:livewire-line-chart
|
||||
:line-chart-model="$lineChart"
|
||||
/>
|
||||
|
||||
<livewire:livewire-column-chart
|
||||
:column-chart-model="$columnChart"
|
||||
/>
|
||||
|
||||
<livewire:livewire-pie-chart
|
||||
:pie-chart-model="$pieChart"
|
||||
/>
|
||||
```
|
||||
|
||||
### Testing
|
||||
|
||||
BIN
preview.gif
Normal file
BIN
preview.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 945 KiB |
Reference in New Issue
Block a user