Update README.md

This commit is contained in:
2022-01-18 17:49:44 +01:00
parent 4512c2f97b
commit 139a3911e5

View File

@@ -2,19 +2,27 @@
API Wrapper for Froxlor. API Wrapper for Froxlor.
## Installation
You can install it via composer:
```console
$ composer require envoyr/php-froxlor-client
```
## How to use ## How to use
```` ```php
$froxlor = new \Envoyr\Froxlor\Server([ $froxlor = new \Envoyr\Froxlor\Server([
'host' => 'https://froxlor.example.com', 'host' => 'https://froxlor.example.com',
'key' => '', 'key' => '',
'secret' => '' 'secret' => ''
]); ]);
```` ```
### Customer ### Customer
```` ```php
$response = $froxlor $response = $froxlor
->customers ->customers
->create([ ->create([
@@ -29,16 +37,16 @@ $response = $froxlor
'api_allowed' => false, 'api_allowed' => false,
'createstdsubdomain' => true, 'createstdsubdomain' => true,
]); ]);
```` ```
### Email ### Email
```` ```php
$response = $froxlor $response = $froxlor
->customer('example') ->customer('example')
->email('hello@example.com') ->email('hello@example.com')
->attributes; ->attributes;
```` ```
### Info ### Info