From b99de1bd800c8999412e525419fa41198eabcfee Mon Sep 17 00:00:00 2001 From: Alexander Yakovlev Date: Tue, 14 Jun 2022 15:24:33 +0700 Subject: [PATCH] Add README --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b872c9f --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +### Usage + +Open your project or initialize a new one with this composer.json: + +```json +{ + "name": "acme/my-project", + "description": "My project", + "repositories":[ + { + "type":"composer", + "url":"https://packages.destrier.tk", + "only": [ + "oreolek/payeer" + ] + } + ], + "minimum-stability": "dev" +} +``` + +(The `repositories` value is the key here.) + +Type `composer require oreolek/payeer` + +If you don't have a PSR-7 implementation in your project, composer will stop and give you a choice. You can repeat the command with your choice, like this: + +``` +composer require oreolek/payeer php-http/guzzle7-adapter +``` + +Initialize the Payeer\Adapter with your ID and secret key: + +```php +$adapter = new Adapter([ + 'id' => $_ENV['PAYEER_ID'], + 'key' => $_ENV['SECRET'], +]); +``` + +(see `test/PayeerTest.php` for example) + +You can use any method, it is transparently sent to the API as is: + +```php +$response = $adapter->time(); +```