diff --git a/README.md b/README.md index 840b94b..684caf7 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,21 @@ -Syndication (feed) generator library for golang. +## gorilla/feeds -Usage: +Web feed generator library. + +### 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 + +### Usage ```go import ( "fmt" "time" - "github.com/jmoiron/syndicate" + "github.com/gorilla/syndicate" ) now := time.Now() diff --git a/atom.go b/atom.go index fdc8482..a49b399 100644 --- a/atom.go +++ b/atom.go @@ -1,4 +1,4 @@ -package syndicate +package feeds import ( "encoding/xml" diff --git a/doc.go b/doc.go index d13efb8..385b45a 100644 --- a/doc.go +++ b/doc.go @@ -3,7 +3,7 @@ Syndication (feed) generator library for golang. Installing - go get github.com/jmoiron/syndicate + go get github.com/gorilla/feeds Syndicate provides a simple, generic Feed interface with a generic Item object as well as RSS and Atom specific RssFeed and AtomFeed objects which allow access to all of each spec's defined elements. @@ -13,7 +13,7 @@ Create a Feed and some Items in that feed using the generic interfaces: import ( "time" - . "github.com/jmoiron/syndicate" + . "github.com/gorilla/feeds ) now = time.Now() @@ -54,7 +54,7 @@ From here, you can output Atom or RSS versions of this feed easily atom, err := feed.ToAtom() rss, err := feed.ToRss() -You can also get access to the underlying objects that syndicate uses to export its XML +You can also get access to the underlying objects that feeds uses to export its XML atomFeed := &Atom{feed}.AtomFeed() rssFeed := &Rss{feed}.RssFeed() @@ -63,8 +63,8 @@ From here, you can modify or add each syndication's specific fields before outpu atomFeed.Subtitle = "plays the blues" atom, err := ToXML(atomFeed) - rssFeed.Generator = "Golang Syndicate v1.0 (github.com/jmoiron/syndicate)" + rssFeed.Generator = "gorilla/feeds v1.0 (github.com/gorilla/feeds)" rss, err := ToXML(rssFeed) */ -package syndicate +package feeds diff --git a/feed.go b/feed.go index 5948c2c..ccf6fd6 100644 --- a/feed.go +++ b/feed.go @@ -1,4 +1,4 @@ -package syndicate +package feeds import ( "encoding/xml" diff --git a/feed_test.go b/feed_test.go index 39cf711..99f0dd8 100644 --- a/feed_test.go +++ b/feed_test.go @@ -1,4 +1,4 @@ -package syndicate +package feeds import ( "testing" diff --git a/rss.go b/rss.go index 21c3bc0..651258f 100644 --- a/rss.go +++ b/rss.go @@ -1,4 +1,4 @@ -package syndicate +package feeds // rss support // validation done according to spec here: @@ -7,7 +7,6 @@ package syndicate import ( "encoding/xml" "fmt" - //"net/url" "time" ) diff --git a/uuid.go b/uuid.go index 6d4ba1b..51bbafe 100644 --- a/uuid.go +++ b/uuid.go @@ -1,4 +1,4 @@ -package syndicate +package feeds // relevant bits from https://github.com/abneptis/GoUUID/blob/master/uuid.go diff --git a/uuid_test.go b/uuid_test.go index b53dee4..140fbfd 100644 --- a/uuid_test.go +++ b/uuid_test.go @@ -1,4 +1,4 @@ -package syndicate +package feeds import ( "testing"