Load XML-Feed-0.01 into trunk.

[catagits/XML-Feed.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..533a462
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+$Id: README,v 1.1.1.1 2004/05/29 17:29:56 btrott Exp $
+
+This is XML::Feed, an abstraction above the RSS and Atom syndication
+feed formats. It supports both parsing and autodiscovery of feeds.
+
+PREREQUISITES
+
+    * XML::RSS
+    * XML::Atom
+    * LWP
+    * HTML::Parser
+    * URI
+    * DateTime
+    * DateTime::Format::Mail
+    * DateTime::Format::W3CDTF
+    * List::Util
+
+INSTALLATION
+
+XML::Feed installation is straightforward. If your CPAN shell
+is set up, you should just be able to do
+
+    % perl -MCPAN -e 'install XML::Feed'
+
+Download it, unpack it, then build it as per the usual:
+
+    % perl Makefile.PL
+    % make && make test
+
+Then install it:
+
+    % make install
+
+Benjamin Trott / cpan@stupidfool.org