Skip to content

Commit 14de8c6

Browse files
committed
Update readme
1 parent 5a421db commit 14de8c6

File tree

1 file changed

+13
-59
lines changed

1 file changed

+13
-59
lines changed

README.md

Lines changed: 13 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,15 @@
1-
# SwaggerClient-php
2-
The REST API provided by BillaBear
1+
<p align="center">
2+
<img width="450px" src="https://ha-static-data.s3.eu-central-1.amazonaws.com/github-readme-logo.png">
3+
</p>
34

4-
This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
5-
6-
- API version: 1.0.0
7-
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen
8-
For more information, please visit [http://www.billabear.com/support](http://www.billabear.com/support)
9-
10-
## Requirements
11-
12-
PHP 5.5 and later
5+
<p align="center">
6+
<h1 style="text-align: center">BillaBear PHP SDK</h1>
7+
</p>
138

149
## Installation & Usage
15-
### Composer
16-
17-
To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:
18-
19-
```
20-
{
21-
"repositories": [
22-
{
23-
"type": "git",
24-
"url": "https://github.com/billabear/php-sdk.git"
25-
}
26-
],
27-
"require": {
28-
"billabear/php-sdk": "*@dev"
29-
}
30-
}
31-
```
32-
33-
Then run `composer install`
3410

35-
### Manual Installation
36-
37-
Download the files and include `autoload.php`:
38-
39-
```php
40-
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
41-
```
42-
43-
## Tests
44-
45-
To run the unit tests:
46-
47-
```
48-
composer install
49-
./vendor/bin/phpunit
11+
```sh
12+
composer require billabear/php-sdk
5013
```
5114

5215
## Getting Started
@@ -58,17 +21,18 @@ Please follow the [installation procedure](#installation--usage) and then run th
5821
require_once(__DIR__ . '/vendor/autoload.php');
5922

6023
// Configure API key authorization: ApiKeyAuth
61-
$config = BillaBear\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
62-
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
63-
// $config = BillaBear\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');
24+
$config = BillaBear\Configuration::getDefaultConfiguration()
25+
->setHost('YOUR_API_URL')
26+
->setApiKey('X-API-Key', 'YOUR_API_KEY');
27+
6428

6529
$apiInstance = new BillaBear\Api\CheckoutApi(
6630
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
6731
// This is optional, `GuzzleHttp\Client` will be used as default.
6832
new GuzzleHttp\Client(),
6933
$config
7034
);
71-
$body = new \BillaBear\Model\CheckoutBody(); // \BillaBear\Model\CheckoutBody |
35+
$body = new \BillaBear\Model\CheckoutBody();
7236

7337
try {
7438
$result = $apiInstance->createCheckout($body);
@@ -177,16 +141,6 @@ Class | Method | HTTP request | Description
177141
- [SubscriptionPlan](docs/Model/SubscriptionPlan.md)
178142
- [SubscriptionStartBody](docs/Model/SubscriptionStartBody.md)
179143

180-
## Documentation For Authorization
181-
182-
183-
## ApiKeyAuth
184-
185-
- **Type**: API key
186-
- **API key parameter name**: X-API-Key
187-
- **Location**: HTTP header
188-
189-
190144
## Author
191145

192146

0 commit comments

Comments
 (0)