Skip to content

Commit 99c22fe

Browse files
committed
docs: add examples
1 parent 9ed086e commit 99c22fe

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
11
# OpenLRW - PHP Api Client
22

3+
> The easier way to implement OpenLRW into your PHP applications
4+
5+
<p align="center">
6+
<img src="https://scrutinizer-ci.com/g/Apereo-Learning-Analytics-Initiative/OpenLRW-php-api-client/badges/quality-score.png?b=master" title="Scrutinizer Code Quality">
7+
<img src="https://poser.pugx.org/openlrw/api-client/v/stable" alt="stable version">
8+
<img src="https://poser.pugx.org/openlrw/api-client/downloads" alt="downloads counter">
9+
</p>
10+
11+
## Requirements
12+
13+
## Install
14+
`$ composer require openlrw/api-client`
15+
16+
17+
## Usage
18+
19+
#### Initialize the client
20+
```php
21+
use OpenLRW\OpenLRW;
22+
23+
$client = new OpenLRW(URL, KEY, PASSWORD);
24+
```
25+
26+
#### Check if the server is up
27+
```php
28+
29+
$isUp = OpeLRW::isUp();
30+
// or
31+
$isUp = $client::isUp();
32+
```
33+
334

435
## Execute tests
536

0 commit comments

Comments
 (0)