Skip to content

Commit 6190638

Browse files
authored
added usage information
1 parent 7f72dc2 commit 6190638

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,32 @@
44

55
> PHP Wrapper to communicate with the [SinusBot](https://sinusbot.com) API.
66
7+
## Usage
8+
9+
### via Composer
10+
11+
```bash
12+
composer require sinusbot/sinusbot-api-php
13+
```
14+
15+
Require the composer's `autoload.php` in the top of your `php` file:
16+
17+
```php
18+
require __DIR__ . '/vendor/autoload.php';
19+
```
20+
21+
Then you can use the SinusBot API via the `SinusBot\API` class.
22+
23+
### via Source
24+
25+
Download or clone this repository to your disk. After that require the autoload.php:
26+
27+
```php
28+
require __DIR__ . '/../src/autoload.php';
29+
```
30+
31+
Then you can use the SinusBot API via the `SinusBot\API` class.
32+
733
## Examples
834

935
There are a few examples located in the [examples](examples/) directory.
@@ -18,4 +44,4 @@ It's compatible with the consumer and hosting version of the SinusBot.
1844

1945
## Copyright
2046

21-
This libary was originally created by [Manuel Hettche](https://github.com/marburger93) from [TS3index](https://ts3index.com).
47+
This libary was originally created by [Manuel Hettche](https://github.com/marburger93) from [TS3index](https://ts3index.com).

0 commit comments

Comments
 (0)