Merge pull request #23 from elithrar/virtualsue-doc-fixes

docs: Provide a runnable example.

Author: kisielk

README.md

@@ -1,61 +1,70 @@
 ## gorilla/feeds
+[![GoDoc](https://godoc.org/github.com/gorilla/feeds?status.svg)](https://godoc.org/github.com/gorilla/feeds) [![Build Status](https://travis-ci.org/gorilla/feeds.png?branch=master)](https://travis-ci.org/gorilla/feeds)
 
-Web feed generator library.
-
-[![Build Status](https://travis-ci.org/gorilla/feeds.png?branch=master)](https://travis-ci.org/gorilla/feeds)
+feeds is a web feed generator library for generating RSS and Atom feeds from Go
+applications.
 
 ### Goals
 
- * simple interface to create both Atom & RSS 2.0 feeds
- * full support for Atom/RSS2.0 spec elements
- * ability to modify particulars for each spec
+ * Provide a simple interface to create both Atom & RSS 2.0 feeds
+ * Full support for Atom and RSS2.0 spec elements
+ * Ability to modify particulars for each spec
 
 ### Usage
 
 ```go
+package main
 
 import (
     "fmt"
     "time"
     "github.com/gorilla/feeds"
 )
 
-now := time.Now()
-feed := &feeds.Feed{
-    Title:       "jmoiron.net blog",
-    Link:        &feeds.Link{Href: "http://jmoiron.net/blog"},
-    Description: "discussion about tech, footie, photos",
-    Author:      &feeds.Author{"Jason Moiron", "[email protected]"},
-    Created:     now,
-}
-
-feed.Items = []*feeds.Item{
-    &feeds.Item{
-        Title:       "Limiting Concurrency in Go",
-        Link:        &feeds.Link{Href: "http://jmoiron.net/blog/limiting-concurrency-in-go/"},
-        Description: "A discussion on controlled parallelism in golang",
+func main() {
+    now := time.Now()
+    feed := &feeds.Feed{
+        Title:       "jmoiron.net blog",
+        Link:        &feeds.Link{Href: "http://jmoiron.net/blog"},
+        Description: "discussion about tech, footie, photos",
         Author:      &feeds.Author{"Jason Moiron", "[email protected]"},
         Created:     now,
-    },
-    &feeds.Item{
-        Title:       "Logic-less Template Redux",
-        Link:        &feeds.Link{Href: "http://jmoiron.net/blog/logicless-template-redux/"},
-        Description: "More thoughts on logicless templates",
-        Created:     now,
-    },
-    &feeds.Item{
-        Title:       "Idiomatic Code Reuse in Go",
-        Link:        &feeds.Link{Href: "http://jmoiron.net/blog/idiomatic-code-reuse-in-go/"},
-        Description: "How to use interfaces <em>effectively</em>",
-        Created:     now,
-    },
+    }
+
+    feed.Items = []*feeds.Item{
+        &feeds.Item{
+            Title:       "Limiting Concurrency in Go",
+            Link:        &feeds.Link{Href: "http://jmoiron.net/blog/limiting-concurrency-in-go/"},
+            Description: "A discussion on controlled parallelism in golang",
+            Author:      &feeds.Author{"Jason Moiron", "[email protected]"},
+            Created:     now,
+        },
+        &feeds.Item{
+            Title:       "Logic-less Template Redux",
+            Link:        &feeds.Link{Href: "http://jmoiron.net/blog/logicless-template-redux/"},
+            Description: "More thoughts on logicless templates",
+            Created:     now,
+        },
+        &feeds.Item{
+            Title:       "Idiomatic Code Reuse in Go",
+            Link:        &feeds.Link{Href: "http://jmoiron.net/blog/idiomatic-code-reuse-in-go/"},
+            Description: "How to use interfaces <em>effectively</em>",
+            Created:     now,
+        },
+    }
+
+    atom, err := feed.ToAtom()
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    rss, err := feed.ToRss()
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    fmt.Println(atom, "\n", rss)
 }
-
-atom, err := feed.ToAtom()
-rss, err := feed.ToRss()
-
-fmt.Println(atom, "\n", rss)
-
 ```
 
 Outputs: