Skip to content

Commit

Permalink
Updating docs temporarily.
Browse files Browse the repository at this point in the history
  • Loading branch information
joedawson authored Sep 19, 2016
1 parent 150878e commit 610a4d9
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Laravel - TVDB Package

A dedicated Laravel package for the [TVDB.com](http://tvdb.com) API.
A dedicated Laravel package for the [TVDB.com](http://tvdb.com) API. The documentation for this package isn't 100% at the moment as I'm still developing as I go along. So expect the documentation to improve shortly.

## Installation

Expand Down Expand Up @@ -85,15 +85,15 @@ Where `$results` is a JSON response from the TVDB API. Here's an example respons
}
```

# Lookup
# Series

Using a series ID, you can also perform a lookup to fetch further information on a series.

```php
$theWalkingDead = TVDB::lookup('153021');
$theWalkingDead = TVDB::series('153021')->get();
```

The `lookup()` method will also return JSON. Here's an example lookup.
The `get()` method will also return JSON. Here's an example response.

```json
{
Expand Down Expand Up @@ -129,6 +129,22 @@ The `lookup()` method will also return JSON. Here's an example lookup.
}
```

### Actors

You also have the ability to fetch actors from a series too.

```php
$actors = TVDB::series('153021')->actors();
```

### Episodes

You can fetch a full list of episodes too.

```php
$episodes = TVDB::series('153021')->episodes();
```

# Questions

Should you have any questions, please feel free to submit an issue.
Should you have any questions, please feel free to submit an issue.

0 comments on commit 610a4d9

Please sign in to comment.