podcast/doc.go

45 lines
1.5 KiB
Go
Raw Normal View History

2017-02-05 09:56:54 -05:00
// Package podcast generates a fully compliant iTunes and RSS 2.0 podcast feed
// for GoLang using a simple API.
2017-02-02 07:42:33 -05:00
//
2017-02-02 08:26:51 -05:00
// Full documentation with detailed examples located at https://godoc.org/github.com/eduncan911/podcast
2017-02-02 07:42:33 -05:00
//
2017-02-02 23:25:36 -05:00
// Usage
2017-02-02 07:42:33 -05:00
//
2017-02-05 09:56:54 -05:00
// To use, `go get` and `import` the package like your typical GoLang library.
//
2017-02-02 07:42:33 -05:00
// $ go get -u github.com/eduncan911/podcast
//
2017-02-05 09:56:54 -05:00
// import "github.com/eduncan911/podcast"
//
2017-02-02 07:42:33 -05:00
// The API exposes a number of method receivers on structs that implements the
// logic required to comply with the specifications and ensure a compliant feed.
// A number of overrides occur to help with iTunes visibility of your episodes.
//
2017-02-05 09:56:54 -05:00
// Notably, the [Podcast.AddItem(i Item)](#Podcast.AddItem) function performs most
// of the heavy lifting by taking the [Item](#Item) input and performing
// validation, overrides and duplicate setters through the feed.
2017-02-02 08:26:51 -05:00
//
2017-02-05 09:56:54 -05:00
// See the detailed Examples of the API at https://godoc.org/github.com/eduncan911/podcast.
2017-02-02 07:42:33 -05:00
//
2017-02-02 08:41:45 -05:00
// Extensibility
2017-02-02 07:42:33 -05:00
//
// In no way are you restricted in having full control over your feeds. You may
// choose to skip the API methods and instead use the structs directly. The
// fields have been grouped by RSS 2.0 and iTunes fields.
//
// iTunes specific fields are all prefixed with the letter `I`.
//
// References
//
// RSS 2.0: https://cyber.harvard.edu/rss/rss.html
//
// Podcasts: https://help.apple.com/itc/podcasts_connect/#/itca5b22233
2017-02-03 12:03:48 -05:00
//
// Release Notes
//
// 1.0.0
2017-02-04 15:52:45 -05:00
// * Initial release.
// * Full documentation, full examples and complete code coverage.
2017-02-03 12:03:48 -05:00
//
2017-02-02 07:42:33 -05:00
package podcast