modify the readme with the correct/extra information

This commit is contained in:
Tim 2021-11-25 18:40:12 +01:00
parent 6365143399
commit 65830a4283

View File

@ -1,11 +1,15 @@
# SwaggerClient-php
Play perudo with your friends through the api!
Created for/from [https://perudo.loken.nl/api/doc](https://perudo.loken.nl/api/doc)
This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen
Note: It is modified to remove some unused/wrong object deserializations
## Requirements
PHP 5.5 and later
@ -20,11 +24,11 @@ To install the bindings via [Composer](http://getcomposer.org/), add the followi
"repositories": [
{
"type": "git",
"url": "http://github.com/GIT_USER_ID/GIT_REPO_ID.git"
"url": "https://git.loken.nl/ardent/PerudoPhpApi.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
"ardent/perudo-php-api": "*@dev"
}
}
```
@ -39,15 +43,6 @@ Download the files and include `autoload.php`:
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
```
## Tests
To run the unit tests:
```
composer install
./vendor/bin/phpunit
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
@ -205,8 +200,6 @@ Class | Method | HTTP request | Description
All endpoints do not require authorization.
## Author
[Tim/Ardent](https://git.loken.nl/ardent)