=== FeedCache Pipes ===
Contributors: cpjolicoeur
Donate link: http://www.craigjolicoeur.com/blog/feedcache-pipes
Tags: RSS, ATOM, feed, cache
Requires at least: 2.5
Tested up to: 2.9
Stable tag: 1.1.2

Caches RSS Feeds for display on your WP sidebar. A list of RSS urls can be entered and the feeds will be aggregated
into one list ordered by date.

== Requirements ==

* Ruby
* CRON access

== Description ==

FeedCache Pipes will retrieve, cache and store locally a list of RSS feeds that you can then display on your WP site. This prevents multiple HTTP requests with each page load since the feeds can be read from the cache file.

== Installation ==

1. Upload the feedcache-pipes directory to your wordpress wp-content/plugins directory.

2. Set file permissions
  a. Change the file permissions on the fcpipes-config.yml file to rw-rw-rw- (666)
  b. Change the file permissions on the files/ directory to rwxrwxrwx (777)

3. Activate the FeedCache Pipes plugin through your Wordpress plugin menu

4. Setup FeedCache Pipes options under the Options -> FCPipes Options menu
	a. Choose the number of feed groups you want (1-99)
  b. Add your list of RSS feeds 1 per line and set the other options.
  c. Take note of the "CRON Script Settings" section at the bottom - you will need this info

5. Edit the feedcache-cron.rb file
  a. Copy the "fcpipes directory" path from the CRON Script Settings into the "FCPIPES_DIR = ''" variable
  b. Set the number of characters from each RSS feed you want to display

6. Add the feedcache-cron.rb ruby script to your servers CRON job (if you need help with CRON please refer
   to the following URL: http://www.unixgeeks.org/security/newbie/unix/cron-1.html)
  (e.g. 30 * * * * /usr/bin/ruby /path/to/your/wordpress/install/wp-content/plugins/feedcache-pipes/feedcache-cron.rb)

7. Add the following code to your wordpress theme where you want the RSS feed listing to be displayed

	`<?php if (function_exists('fcpipes_display_feeds')) { echo fcpipes_display_feeds(); } ?>`
	
	for the default (group 1) listing or you can specify a group number (in this case, group 3)
	
	`<?php if (function_exists('fcpipes_display_feeds)) { echo fcpipes_display_feeds(3); } ?>`
	
	If you don't specify a group number in the function call, then Group 1 will be used.  If you want to 
	specify the specific group number to display use "fcpipes_display_feeds(__GROUP_NUMBER__)" where
	__GROUP_NUMBER__ is the number you want to display.

8. Sit back and enjoy the plugin


== Upgrading ==

1. Deactivate the previous version of FeedCache Pipes through your Wordpress plugins menu

2. Upload the new feedcache-cron.rb, feedcache-pipes.php and complete lib/ directory files to your existing feedcache-pipes directory.  You do not need to overwrite your existing files/ directory or the fcpipes-config.yml file.

3. Activate the newly uploaded plugin.
  * Go to Settings -> FeedCache Pipes and update your FeedCache Pipes settings (click update even if you haven't made changes)

4. Enter the correct FCPIPES_DIR variable in the feedcache-cron.rb script
  * update your MYSQL_SOCKET setting as well if the MySQL socket on your server is not the default (/tmp/mysql.sock)


== Frequently Asked Questions ==

= Why would I need this plugin? =

If you are using your WP installation to display other website's RSS feeds, this will save HTTP requests and improve page load times for your users.

= Will FeedCache Pipes work with Atom feeds? = 

Yes! FeedCache Pipes will work with both RSS and ATOM feeds.

= Can I receive error emails from the CRON process? =

Yes, just set CRON_EMAILS = true in the feedcache-cron.rb script.  Error emails are turned off by default.


== Changelog ==

= 1.1.2 =
* properly quote strings for config file

= 1.1.1 =
* bugfix release - DB password wasn't being called properly in CRON script

= 1.1 =
* added option to strip HTML tags for each feed group
* only use a single YAML config file now.  don't need additional master-config.txt file

= 1.0.2 =
* minor layout and readme updates

= 1.0.1 =
* major updates
* cleaned up how options are stored
* added XML output for each feed group
* set number of items per feed group
* use DB to store feed data instead of text files

= 0.9.9 =
* rework plugin update process

= 0.9.8 =
* Allow for multiple RSS Groups

= 0.5 =
* Initial Release


== Screenshots ==

1. FeedCache Pipes Settings page
