From 43e89615e771d2e04a31f5afbeae82d6474d8405 Mon Sep 17 00:00:00 2001 From: Nate Kane Date: Tue, 3 May 2011 23:27:12 +1000 Subject: [PATCH] Updated readme with RSS Feed information and usage. --- readme.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/readme.md b/readme.md index 0b980b4..29071bf 100644 --- a/readme.md +++ b/readme.md @@ -42,6 +42,23 @@ The easiest way to customize the Postmarkdown functionality or appearance is by $ rails generate postmarkdown:override --model # overrides `app/models/post.rb` $ rails generate postmarkdown:override --views # overrides all files in directory `app/views/posts/` +## RSS Feed + +Postmarkdown comes prepared with a fully functional RSS feed. + +You can take advantage of the built-in feed by adding the feed link to your HTML head tag. For example, simply add the following to your default layout: + + + + <%= yield :head %> + + +To customize the feed title, add the following to your application.rb: + + Postmarkdown::Config.options[:feed_title] = 'Custom Blog Title Goes Here' + +To link to the feed in your app, simply use the route helper: `<%= link_to 'RSS Feed', posts_feed_path %>` + ## Customizing Routes By default Postmarkdown will setup all routes to go through the `/posts/*` path. For example: