From ae5e90ae1feb6e4a4a531f8af6360b3314715499 Mon Sep 17 00:00:00 2001
From: Christine Dodrill <xena@yolo-swag.com>
Date: Wed, 12 Aug 2015 19:06:46 -0700
Subject: [PATCH] Add go documentation

---
 client/go/README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++
 client/go/get.go    |  7 +++++
 2 files changed, 72 insertions(+)
 create mode 100644 client/go/README.md

diff --git a/client/go/README.md b/client/go/README.md
new file mode 100644
index 0000000..ab5f5d0
--- /dev/null
+++ b/client/go/README.md
@@ -0,0 +1,65 @@
+# ponyapi
+
+    import "github.com/Xe/PonyAPI/client/go"
+
+Package ponyapi provides glue for applications written in Go that want to use
+PonyAPI for getting information.
+
+## Usage
+
+#### type Episode
+
+```go
+type Episode struct {
+	AirDate int    `json:"air_date"`
+	Episode int    `json:"episode"`
+	IsMovie bool   `json:"is_movie"`
+	Name    string `json:"name"`
+	Season  int    `json:"season"`
+}
+```
+
+Episode is an episode of My Little Pony: Friendship is Magic.
+
+#### func  GetEpisode
+
+```go
+func GetEpisode(season, episode int) (*Episode, error)
+```
+GetEpisode gets information about season x episode y or an error.
+
+#### func  Newest
+
+```go
+func Newest() (*Episode, error)
+```
+Newest returns information on the newest episode or an error.
+
+#### func  Random
+
+```go
+func Random() (*Episode, error)
+```
+Random returns information on a random episode.
+
+#### func  AllEpisodes
+
+```go
+func AllEpisodes() ([]*Episode, error)
+```
+AllEpisodes gets all information on all episodes or returns an error.
+
+#### func  GetSeason
+
+```go
+func GetSeason(season int) ([]*Episode, error)
+```
+GetSeason returns all information on season x or returns an error.
+
+#### func  Search
+
+```go
+func Search(query string) ([]*Episode, error)
+```
+Search takes the give search terms and uses that to search the list of 
+episodes.
diff --git a/client/go/get.go b/client/go/get.go
index 5a58594..ad2d114 100644
--- a/client/go/get.go
+++ b/client/go/get.go
@@ -56,26 +56,33 @@ func getEpisodes(fragment string) ([]*Episode, error) {
 	return eswr.Episodes, nil
 }
 
+// Newest returns information on the newest episode or an error.
 func Newest() (*Episode, error) {
 	return getEpisode("/newest")
 }
 
+// Random returns information on a random episode.
 func Random() (*Episode, error) {
 	return getEpisode("/random")
 }
 
+// GetEpisode gets information about season x episode y or an error.
 func GetEpisode(season, episode int) (*Episode, error) {
 	return getEpisode(fmt.Sprintf("/season/%d/episode/%d", season, episode))
 }
 
+// AllEpisodes gets all information on all episodes or returns an error.
 func AllEpisodes() ([]*Episode, error) {
 	return getEpisodes("/all")
 }
 
+// GetSeason returns all information on season x or returns an error.
 func GetSeason(season int) ([]*Episode, error) {
 	return getEpisodes(fmt.Sprintf("/season/%d", season))
 }
 
+// Search takes the give search terms and uses that to search the
+// list of episodes.
 func Search(query string) ([]*Episode, error) {
 	path, err := url.Parse("/search")
 	if err != nil {