BuzzFeed Perl Widget Builder
===============================================================================
Version 1.4.2
September 3, 2009
http://www.buzzfeed.com/network/plugin
---------------------
1. What's this?
2. Prerequisites 
3. Installation/Configuration
4. Example Use
5. Cron
6. More Information
---------------------


1. What's this? 
-- ------------
The BuzzFeed Perl Widget Builder allows you to have the latest headlines from http://buzzfeed.com displayed on your web page. The widget builder will download widget images and html/markup locally to allow inclusion in any web page. 


2. Prerequisites
-- -------------
Needs HTML::Template and JSON perl modules.


3. Installation/Configuration
-- --------------------------
* Rename BFConfig-default.pm to BFConfig.pm.
* Edit BFConfig.pm to suite your needs.
* Rename templates/buzz-default.html to buzz.html


4. Example Use
-- -----------

Options:

  'perl -I /path2/bf-widget/lib -I /path2/bf-widget /path2/bf-widget/buzz.pl -v'

    usage buzz.pl [-t tame] [-c cats] [-o output_file] [-i image_path] [-r rel_image] [-u username]
      
      -h  print this help message.
      -v  print debugging messages.
      -t  tame buzz. exclude buzz that may offend sensitive readers.
      -c  a comma separated list of categories to display [-l to list] (defaults to all).
      -b  latest badged buzz (overrides -c) (excludes trashy badge if -t is passed)
      -u filter by username
      -l  list available categories.
      -o  output buzz to specified file.
      -i  absolute image path (ie: /apache/htdocs/images/buzzfeed).
      -r  relative image path (ie: /images/buzzfeed).
      -s use small images

To download widget markup: 

  'perl -I /path2/bf-widget/lib -I /path2/bf-widget /path2/bf-widget/buzz.pl'

This should download the widget images and output a html file containing the widget markup. You can then include the widget markup in your web page using server side includes or some other mechanism.

You can also run the widget test suite...

cd /path2/bf-widget; perl ./t/TEST.pl

5. Cron
-- ----
Set up a cron job to run every 10 minutes or so to continue to grab the latest buzzfeed widget data.

   0,15,30,45 * * * * /path2perl/perl -I /path2/bf-widget/lib -I /path2/bf-widget /path2/bf-widget/buzz.pl

   
6. More Information
-- ----------------
Check http://www.buzzfeed.com/network/plugin for more Information, if you 
can't find what you're looking for you can always ask for more help at 
support@buzzfeed.com.