@@ -9,12 +9,27 @@ Parse nearly any RSS and Atom feeds in Ruby. 3000 unit tests. Open source. == Installation +For Debian-based systems: + + $ sudo apt-get install libxml-ruby1.8 # or libxml-parser-ruby1.8 + +TODO: dependency installation instructions for other platforms. + +And then: + $ sudo gem install rfeedparser Or for the latest development version: $ git clone git://github.com/technomancy/rfeedparser.git +Dependencies on other gems are handled by rubygems, but rfeedparser +also relies on having bindings to a native XML parsing library. The +recommended choice is libxml, which is installable with the +libxml-ruby1.8 package in Debian-based systems. But it can also fall +back to expat (the libxml-parser-ruby1.8 Debian package) if libxml is +not installed. + == Usage require 'rubygems' # may omit if installed manually README @@ -27,7 +27,7 @@ spec = Gem::Specification.new do |s| s.add_dependency('htmltools', '>= 1.10') s.add_dependency('htmlentities', '4.0.0') s.add_dependency('mongrel', '>=1.0.1') - s.requirements << "Yoshida Masato's Ruby bindings to the Expat XML parser" + s.requirements << "Yoshida Masato's Ruby bindings to the Expat XML parser or libxml" end Rakefile @@ -1,3 +1,12 @@ +# If you don't have libxml installed (or for some reason you would +# rather use expat) you can fall back upon this for your parser. Be +# advised that the bindings for expat are much older (from the days of +# Ruby 1.6.7) and are unmaintained. If you want to force use of expat +# even when libxml is installed, you can do this: +# +# feed = FeedParser.parse("some-feed-stream-filepath-or-url", +# :strict => FeedParser::Expat::StrictFeedParser) + require 'xml/saxdriver' module FeedParser lib/rfeedparser/expat_parser.rb e8e178fe6d2b687e57e5fe398e6e315f9e3f0e56 Phil Hagelberg technomancy@gmail.com http://github.com/jmhodges/rfeedparser/commit/8113d0a1ace05e28a47b93fc609c491046787ead 8113d0a1ace05e28a47b93fc609c491046787ead 2008-05-06T14:22:55-07:00 2008-05-06T14:22:55-07:00 more explanation about the difference between expat and libxml d7e6a40e4599394ab723338136cf30b6b11ff7e3 Phil Hagelberg technomancy@gmail.com