Skip to content

Commit 00a3d0f

Browse files
authored
Updated README.md
1 parent 3f7b359 commit 00a3d0f

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
1-
# byu-jwt-php
1+
# JWT Decoding and Validation for BYU API
2+
3+
Basic JWT Decoding and Validation for calls from BYU's API repository
4+
5+
## Installing via composer
6+
7+
Install into your project using [composer](http://getcomposer.org).
8+
For existing applications you can add the
9+
following to your composer.json file:
10+
11+
"require": {
12+
"byu-oit/jwt": "~1.0"
13+
}
14+
15+
And run `php composer.phar update`
16+
17+
## Usage
18+
19+
The most common use case is simply decoding a JWT:
20+
```php
21+
try {
22+
$decoded = BYUJWT::decode($jwt);
23+
} catch (Exception $e) {
24+
//JWT was not valid, do something
25+
}
26+
```

0 commit comments

Comments
 (0)