diff --git a/.scrutinizer.yml b/.scrutinizer.yml deleted file mode 100644 index 606b2b2..0000000 --- a/.scrutinizer.yml +++ /dev/null @@ -1,19 +0,0 @@ -filter: - excluded_paths: - - tests/* - -checks: - php: - code_rating: true - -tools: - external_code_coverage: true - php_analyzer: true - php_changetracking: true - php_code_sniffer: - config: - standard: "PSR2" - php_cpd: true - php_mess_detector: true - php_pdepend: true - sensiolabs_security_checker: true \ No newline at end of file diff --git a/README.md b/README.md index dc8bb9a..e9c837f 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,11 @@ ![Downloads](https://img.shields.io/packagist/dt/akaunting/laravel-apexcharts) ![Tests](https://img.shields.io/github/workflow/status/akaunting/laravel-apexcharts/Tests?label=tests) [![StyleCI](https://github.styleci.io/repos/452221855/shield?style=flat&branch=master)](https://styleci.io/repos/452221855) -[![Quality](https://img.shields.io/scrutinizer/quality/g/akaunting/laravel-apexcharts?label=quality)](https://scrutinizer-ci.com/g/akaunting/laravel-apexcharts) [![License](https://img.shields.io/github/license/akaunting/laravel-apexcharts)](LICENSE.md) -This package allows you to generate modern and interactive charts using the [ApexCharts](https://apexcharts.com) library directly from Laravel without interacting with JavaScript, CSS, etc. +This package allows you to generate modern and interactive charts using the [ApexCharts](https://apexcharts.com) library directly from `Laravel` without interacting with JavaScript, CSS, etc. + +It covers all of the chart [types](https://apexcharts.com/docs/chart-types/line-chart) and [options](https://apexcharts.com/docs/options/annotations) available within the `ApexChart` library. ## Getting Started @@ -28,14 +29,18 @@ php artisan vendor:publish --tag=apexcharts ### 3. Configure -You can change the column sorting settings of your app from `config/apexcharts.php` file +You can change the chart settings of your app from `config/apexcharts.php` file ## Usage +First of all, create an instance of the `Chart` class and set the data and options according to your needs. + ```php -use Akaunting\Apexcharts\Charts; +use Akaunting\Apexcharts\Chart; -$chart = new Charts(); +... + +$chart = new Chart(); $chart->setType('donut') ->setWidth('100%') @@ -45,28 +50,25 @@ $chart->setType('donut') $chart->setDataset('Name', 'donut', [1907, 1923]); ``` -## Blade +Then, include the JavaScript (on every page using charts). -```php - - -
- - - - +```html +... -