diff --git a/LICENSE b/LICENSE index cb92d29..c27286e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2024, Ivan Stasiuk +Copyright (c) 2024, Ivan Stasiuk (stasi.uk) Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/README.md b/README.md index 2753353..55965f6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ -# wizall-api-client-php +# wizall-api-client + +[![Latest Stable Version](https://img.shields.io/github/v/release/brokeyourbike/wizall-api-client-php)](https://github.com/brokeyourbike/wizall-api-client-php/releases) +[![Total Downloads](https://poser.pugx.org/brokeyourbike/wizall-api-client/downloads)](https://packagist.org/packages/brokeyourbike/wizall-api-client) +[![Maintainability](https://api.codeclimate.com/v1/badges/1b04658a54cfb29e4896/maintainability)](https://codeclimate.com/github/brokeyourbike/wizall-api-client-php/maintainability) +[![Test Coverage](https://api.codeclimate.com/v1/badges/1b04658a54cfb29e4896/test_coverage)](https://codeclimate.com/github/brokeyourbike/wizall-api-client-php/test_coverage) + Wizall API client for PHP + +## Installation + +```bash +composer require brokeyourbike/wizall-api-client +``` + +## Usage + +```php +use BrokeYourBike\Wizall\Client; +use BrokeYourBike\Wizall\Interfaces\ConfigInterface; + +assert($config instanceof ConfigInterface); +assert($httpClient instanceof \GuzzleHttp\ClientInterface); +assert($psrCache instanceof \Psr\SimpleCache\CacheInterface); + +$apiClient = new Client($config, $httpClient, $psrCache); +$apiClient->getAuthToken(); +``` + +## Authors +- [Ivan Stasiuk](https://github.com/brokeyourbike) | [Twitter](https://twitter.com/brokeyourbike) | [LinkedIn](https://www.linkedin.com/in/brokeyourbike) | [stasi.uk](https://stasi.uk) + +## License +[Mozilla Public License v2.0](https://github.com/brokeyourbike/wizall-api-client-php/blob/main/LICENSE)