diff --git a/README.md b/README.md index 2fdc088..b104791 100755 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ Neat Livewire Charts for your Laravel projects. +### Preview + +![preview](https://github.com/asantibanez/livewire-charts/raw/master/preview.gif) + ## 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 + + + + ``` ### Testing diff --git a/preview.gif b/preview.gif new file mode 100644 index 0000000..fa21797 Binary files /dev/null and b/preview.gif differ