aboutsummaryrefslogtreecommitdiffstats
path: root/lib/rss
diff options
context:
space:
mode:
Diffstat (limited to 'lib/rss')
-rw-r--r--lib/rss/2.0.rb31
-rw-r--r--lib/rss/atom.rb2
2 files changed, 32 insertions, 1 deletions
diff --git a/lib/rss/2.0.rb b/lib/rss/2.0.rb
index 9622c598d9..5c0caecd73 100644
--- a/lib/rss/2.0.rb
+++ b/lib/rss/2.0.rb
@@ -2,6 +2,37 @@ require "rss/0.9"
module RSS
+ ##
+ # = RSS 2.0 support
+ #
+ # RSS has three different versions. This module contains support for version
+ # 2.0[http://www.rssboard.org/rss-specification]
+ #
+ # == Producing RSS 2.0
+ #
+ # Producing our own RSS feeds is easy as well. Let's make a very basic feed:
+ #
+ # require "rss"
+ #
+ # rss = RSS::Maker.make("2.0") do |maker|
+ # maker.channel.language = "en"
+ # maker.channel.author = "matz"
+ # maker.channel.updated = Time.now.to_s
+ # maker.channel.link = "http://www.ruby-lang.org/en/feeds/news.rss"
+ # maker.channel.title = "Example Feed"
+ # maker.channel.description = "A longer description of my feed."
+ # maker.items.new_item do |item|
+ # item.link = "http://www.ruby-lang.org/en/news/2010/12/25/ruby-1-9-2-p136-is-released/"
+ # item.title = "Ruby 1.9.2-p136 is released"
+ # item.updated = Time.now.to_s
+ # end
+ # end
+ #
+ # puts rss
+ #
+ # As you can see, this is a very Builder-like DSL. This code will spit out an
+ # RSS 2.0 feed with one item. If we needed a second item, we'd make another
+ # block with maker.items.new_item and build a second one.
class Rss
class Channel
diff --git a/lib/rss/atom.rb b/lib/rss/atom.rb
index fc16a381c1..d3524231ff 100644
--- a/lib/rss/atom.rb
+++ b/lib/rss/atom.rb
@@ -8,7 +8,7 @@ module RSS
#
# The Atom module provides support in reading and creating feeds.
#
- # See the RSS module for examples consuming and creating feeds
+ # See the RSS module for examples consuming and creating feeds.
module Atom
##