Skip to content
This repository has been archived by the owner on Feb 14, 2021. It is now read-only.

Commit

Permalink
Fix ugly readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
romanzipp authored and Micky5991 committed Jul 27, 2018
1 parent d229062 commit c18310c
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# laravel-ts3admin
[par0noid's ts3admin.class](https://github.com/par0noid/ts3admin.class) integration for Laravel 5.3 and higher

> **INFO:** This package uses a singleton to access a **single** ts3admin.class-object. So you currently **can't access multiple TeamSpeak-3-Servers**!
**INFO:** This package uses a singleton to access a **single** ts3admin.class-object. So you currently **can't access multiple TeamSpeak-3-Servers**!

### Supported Laravel Versions

Expand All @@ -10,34 +10,47 @@
| 5.3 | :heavy_check_mark: |
| 5.4 | :heavy_check_mark: |
| 5.5 | :heavy_check_mark: |
| 5.6 | :heavy_check_mark: |

### Installation
- `composer require micky5991/laravel-ts3admin`
## Installation

```
composer require micky5991/laravel-ts3admin
```

**If you use Laravel 5.5+ you are already done, otherwise continue:**

Add Service Provider to your `app.php` configuration-file:

*If you use Laravel 5.5+ you are already done, otherwise continue:*
- Add Service Provider to your `app.php` configuration-file:
```php
Micky5991\laravel_ts3admin\Providers\TeamspeakServiceProvider::class
```
- Copy configuration to config-folder:

## Configuration

Copy configuration to config-folder:

```bash
$ php artisan vendor:publish --provider=Micky5991\laravel_ts3admin\Providers\TeamspeakServiceProvider
```

- Add environmental variables to your `.env`
Add environmental variables to your `.env`

```
TS_SERVER_HOST=127.0.0.1
TS_SERVER_PORT=9987
TS_SERVER_TIMEOUT=2
TS_QUERY_PORT=10011
TS_QUERY_USERNAME=serveradmin
TS_QUERY_PASSWORD=secretpassword
TS_QUERY_PASSWORD=supersecretpassword
```
### Configuration

After completing all steps from above you should have a configuration file under: `config/teamspeak.php`. There you can configure some other aspects like the name of the ServerQuery.

### Example
## Example

An example for a controller to the `/clients` endpoint that lists all connected clients.

```php
Route::get('/users', function(\ts3admin $ts) {
$result = $ts->clientList();
Expand Down

0 comments on commit c18310c

Please sign in to comment.