Skip to content

Commit

Permalink
Added requirements and how to install to README
Browse files Browse the repository at this point in the history
  • Loading branch information
bensherred committed Nov 29, 2019
1 parent 0d3967f commit bb7da6e
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions readme.md
Expand Up @@ -5,6 +5,7 @@
<a href="https://github.styleci.io/repos/57324164"><img src="https://github.styleci.io/repos/57324164/shield?branch=master" alt="StyleCI Status"></a>
<a href="https://packagist.org/packages/truckersmp/api-client"><img src="https://poser.pugx.org/truckersmp/api-client/downloads" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/truckersmp/api-client"><img src="https://poser.pugx.org/truckersmp/api-client/v/stable" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/truckersmp/api-client"><img src="https://poser.pugx.org/truckersmp/api-client/v/unstable" alt="Latest Unstable Version"></a>
<a href="https://packagist.org/packages/truckersmp/api-client"><img src="https://poser.pugx.org/truckersmp/api-client/license" alt="License"></a>
</p>

Expand All @@ -15,6 +16,24 @@ language. It includes a pre-defined set of classes for API each endpoint to get

If you want to use the API without the library, check out the [API Documentation](https://stats.truckersmp.com/api).

## Requirements

PHP 7.2 or later

## Composer

You can install the package via [Composer](https://getcomposer.org). Run the following command:

```bash
composer require truckersmp/api-client
```

To use the package, use Composer's [autoload](https://getcomposer.org/doc/01-basic-usage.md#autoloading):

```php
require_once('vendor/autoload.php');
```

## Official Documentation

Documentation for API client can be found on the [Wiki](https://github.com/TruckersMP/API-Client/wiki).
Expand Down

0 comments on commit bb7da6e

Please sign in to comment.