Commits

Miki Tebeka committed 8bdb63e

Changelog and updated docs

Comments (0)

Files changed (2)

+feedme 0.0.3 (Thu Dec 30 09:57:35 PST 2010)
+    * Added :id
+    * Some usage documentation in README.rst
+
 feedme 0.0.2 (Sat Mar 06 18:04:21 2010 -0800)
     * Categories as string vector
     * :contents -> :content
 
 An RSS/Atom parser for Clojure
 
+Usage
+=====
+Add the following dependency to `project.clj`::
+    
+    [feedme "0.0.3"]
+
+Then in your code::
+
+    (require 'feedme)
+    
+    (let [feed (feedme/parse "http://rss.slashdot.org/Slashdot/slashdot")
+          entry (nth (:entries feed) 0)]
+        (println (format "%s [%s]" (:title entry) (:published entry))))
+
+Fields
+======
+
+feed
+----
+:: 
+
+    :author
+    :description
+    :language
+    :link
+    :type
+    :published
+    :title
+    :entries
+
+entry
+-----
+:: 
+
+    :author
+    :categories
+    :content-type
+    :content
+    :id
+    :link
+    :published
+    :title
+    :updated
+
+
 License
 =======
 MIT (see LICENSE.txt)