Skip to content

Commit 7696db3

Browse files
author
Felix Schäfer
committed
Added Installation Instructions
1 parent ac889d0 commit 7696db3

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Arma RCon Class for PHP (ARC)
1+
# Arma RCon Class (ARC) 1.3 for PHP
22

33
ARC is a lightweight PHP class, which let's you easily send commands via RCon to your Arma server. See "Supported Server" for a full list of supported Arma games.
44
<br>
@@ -17,6 +17,21 @@ Please consider that mods normally don't change the BattlEye server settings, so
1717
ARC only requires **PHP 5.3**, nothing more!
1818
<br>
1919
<br>
20+
## Installation
21+
#### Via Composer
22+
If you haven't already, download Composer
23+
```shell
24+
$ curl -s http://getcomposer.org/installer | php
25+
```
26+
Now require and install ARC
27+
```shell
28+
$ composer require nizarii/arma-rcon-class "1.3.*"
29+
$ composer install
30+
```
31+
#### Without Composer
32+
Just include ARC in your project: `require_once 'ArmaRConClass/rcon.php';`
33+
<br>
34+
<br>
2035
## Examples
2136
#### Getting started
2237
After including `rcon.php` in your project, you need to create a new object. It will automatically create a new connection to the server, so you don't need to call `connect()`, e.g.:
@@ -44,7 +59,7 @@ try
4459
}
4560
catch (Exception $e)
4661
{
47-
echo "Ups! Something went wrong: ".$e->getMessage();
62+
echo "Ups! Something went wrong: {$e->getMessage()}";
4863
}
4964
```
5065
#### Options

0 commit comments

Comments
 (0)