diff --git a/README.md b/README.md index bac684b..3eebbed 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,52 @@ PonyAPI ======= -A simple API for episodes of My Little Pony: Friendship is Magic to be run +A simple API for episodes of My Little Pony: Friendship is Magic to be run inside a container. + +API Usage +--------- + +An episode will have the following data type: + +```json +{ + "air_date": 1286735400, + "episode": 1, + "is_movie": false, + "name": "Friendship is Magic Part 1", + "season": 1 +} +``` + +This represents Season 1, Episode 1 of My Little Pony: Friendship Is Magic. The +`air_date` column represents the date and time that the episode was originally +shown on The Hub (now Discovery Family Network). If `is_movie` is set and the +season number is `99`, the episode record should be treated as a movie. + +### `/all` + +Returns all information about all episodes. This returns an array of Episode +objects as defined above. + +### `/season/` + +Returns all information about episodes in the given season number or a `404` +reply if no episodes could be found. To get all information about the movies +shown, set the season as `99`. + +### `/season//episode/