Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
farshidrezaei committed Oct 28, 2021
1 parent c255de3 commit a8ee31b
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 31 deletions.
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,35 @@ in progress:
- [X] donut chart
- [X] abstract chart (customizable)


## Installation

### composer

```bash
composer require farshidrezaei/chartio
```

## Chartio environment
Set bellow config to `.env` file with your installed node and npm path
```dotenv
NODE_PATH=
NPM_PATH=
```

## Customization

for publish config file:
```bash
php artisan vendor:publish --provider="FarshidRezaei\Chartio\Providers\ChartioServiceProvider" --tag="config"
```

for publish view files :
```bash
php artisan vendor:publish --provider="FarshidRezaei\Chartio\Providers\ChartioServiceProvider" --tag="views"
```


## Usage
Here's a quick example:

Expand Down Expand Up @@ -318,21 +340,6 @@ export example:
![exported chart image](https://github.com/farshidrezaei/chartio/blob/main/doc/abstract.png)


-----------
## Customization

for publish config file:
```bash
php artisan vendor:publish --provider="FarshidRezaei\Chartio\Providers\ChartioServiceProvider" --tag="config"
```

for publish view files :
```bash
php artisan vendor:publish --provider="FarshidRezaei\Chartio\Providers\ChartioServiceProvider" --tag="views"
```




## License

Expand Down
11 changes: 10 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,18 @@
"authors": [
{
"name": "Farshid Rezaei",
"email": "[email protected]"
"email": "[email protected]",
"homepage": "https://farshidrezaei.ir",
"role": "Full-Stack Web Developer"
}
],
"extra": {
"laravel": {
"providers": [
"FarshidRezaei\\Chartio\\Providers\\ChartioServiceProvider"
]
}
},
"autoload": {
"files": [
"src/Helpers/helpers.php"
Expand Down
37 changes: 22 additions & 15 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,35 @@ in progress:
- [X] donut chart
- [X] abstract chart (customizable)


## Installation

### composer

```bash
composer require farshidrezaei/chartio
```

## Chartio environment
Set bellow config to `.env` file with your installed node and npm path
```dotenv
NODE_PATH=
NPM_PATH=
```

## Customization

for publish config file:
```bash
php artisan vendor:publish --provider="FarshidRezaei\Chartio\Providers\ChartioServiceProvider" --tag="config"
```

for publish view files :
```bash
php artisan vendor:publish --provider="FarshidRezaei\Chartio\Providers\ChartioServiceProvider" --tag="views"
```


## Usage
Here's a quick example:

Expand Down Expand Up @@ -318,21 +340,6 @@ export example:
![exported chart image](https://github.com/farshidrezaei/chartio/blob/main/doc/abstract.png)


-----------
## Customization

for publish config file:
```bash
php artisan vendor:publish --provider="FarshidRezaei\Chartio\Providers\ChartioServiceProvider" --tag="config"
```

for publish view files :
```bash
php artisan vendor:publish --provider="FarshidRezaei\Chartio\Providers\ChartioServiceProvider" --tag="views"
```




## License

Expand Down

0 comments on commit a8ee31b

Please sign in to comment.