85 lines
2.9 KiB
Markdown
85 lines
2.9 KiB
Markdown
# A Laravel wrapper for the Bokio API
|
|
|
|
[](https://packagist.org/packages/mattitjaab/bokio-api-laravel)
|
|
[](https://github.com/mattitjaab/bokio-api-laravel/actions?query=workflow%3Arun-tests+branch%3Amain)
|
|
[](https://github.com/mattitjaab/bokio-api-laravel/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
|
|
[](https://packagist.org/packages/mattitjaab/bokio-api-laravel)
|
|
|
|
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
|
|
|
|
## Support us
|
|
|
|
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/bokio-api-laravel.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/bokio-api-laravel)
|
|
|
|
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
|
|
|
|
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
|
|
|
|
## Installation
|
|
|
|
You can install the package via composer:
|
|
|
|
```bash
|
|
composer require mattitjaab/bokio-api-laravel
|
|
```
|
|
|
|
You can publish and run the migrations with:
|
|
|
|
```bash
|
|
php artisan vendor:publish --tag="bokio-api-laravel-migrations"
|
|
php artisan migrate
|
|
```
|
|
|
|
You can publish the config file with:
|
|
|
|
```bash
|
|
php artisan vendor:publish --tag="bokio-api-laravel-config"
|
|
```
|
|
|
|
This is the contents of the published config file:
|
|
|
|
```php
|
|
return [
|
|
];
|
|
```
|
|
|
|
Optionally, you can publish the views using
|
|
|
|
```bash
|
|
php artisan vendor:publish --tag="bokio-api-laravel-views"
|
|
```
|
|
|
|
## Usage
|
|
|
|
```php
|
|
$bokioApiLaravel = new Mattitja\BokioApiLaravel();
|
|
echo $bokioApiLaravel->echoPhrase('Hello, Mattitja!');
|
|
```
|
|
|
|
## Testing
|
|
|
|
```bash
|
|
composer test
|
|
```
|
|
|
|
## Changelog
|
|
|
|
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
|
|
|
|
## Contributing
|
|
|
|
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
|
|
|
|
## Security Vulnerabilities
|
|
|
|
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
|
|
|
|
## Credits
|
|
|
|
- [Mattitja AB](https://github.com/MattitjaAB)
|
|
- [All Contributors](../../contributors)
|
|
|
|
## License
|
|
|
|
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|