Skip to content

Commit 4f1d005

Browse files
committed
2 parents e1817af + 350bfd4 commit 4f1d005

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,35 @@ use OpenLRW\OpenLRW;
2727
$client = new OpenLRW(URL, KEY, PASSWORD);
2828
```
2929

30+
### Generate a JSON Web Token
31+
```php
32+
OpenLRW::generateJwt();
33+
```
34+
35+
### Get data
36+
```php
37+
$user = OneRoster::get('users/test2u'); // return the data for the user 'test2u'
38+
```
39+
3040
### Using OneRoster Model
3141
> Example with the User collection
3242
3343
#### Get an entity
3444
```php
35-
$user = User::find('foo-bar');
45+
$user = User::find('foo-bar'); // return a User object
3646
echo $user->sourcedId; // return 'foo-bar'
47+
3748
```
3849

3950
#### Delete
4051
```php
4152
$user = User::find('foo-bar');
4253
$user->delete(); // User deleted
54+
55+
// Or
56+
57+
User::destroy('foo-bar);
58+
4359
```
4460

4561

@@ -56,4 +72,4 @@ $isServerUp = OpenLRW::isUp();
5672
5773
```bash
5874
\vendor\bin\phpunit.bat --bootstrap vendor\autoload.php tests\ApiClientTest.php
59-
```
75+
```

0 commit comments

Comments
 (0)