BuzzFeed PHP Widget Builder
===============================================================================
Version 0.1
2007/August/06
http://www.buzzfeed.com/network/plugin
---------------------
1. Whats this?
2. Prerequisites 
3. Installation/Configuration
4. Example Use
5. Static Export
6. More Information
7. Licensing (GPL)
---------------------



1. What's this? 
-- ------------
   BuzzFeed PHP Widget Builder allows you to have the latest headlines from 
buzzfeed.com displayed on your web page. 



2. Prerequisites
-- ------------

   All you need is a working version of PHP 4 (or newer). 



3. Installation/Configuration
-- --------------------------
   First rename the following files in the buzzfeed-php folder: 
config-default.php -> config.php
template-default.php -> template.php
cache-default.php -> cache.php
   
   This way you can easily upgrade to a newer version and won't have to worry 
about your files being overwritten. Edit config.php and adapt it to your needs.
All the settings are well documented in the config file itself. 

   Upload the buzzfeed-php folder to your server. If you would like to use 
the built in caching system change the permission of cache.php to 777.
 


4. Example Use
-- -----------
   include( "buzzfeed-php/buzzfeed.class.php" ); 
   $bf = new BuzzFeed(); 
   $bf->outputHTML(); 
   
   
   
5. Static Export
-- -------------
   A few people might want to run a cronjob every now and then that writes the 
generated HTML to a file. From the buzzfeed-api folder just run 'php cron.php -h'
to get full documentation on all the options. Generally all you will need is 
'php cron.php -c my-config.php -o export.html'. 

Sorry windows users, this only works in linux/unix.  



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 
network@buzzfeed.com. 


7. Licensing (GPL)
-- ---------------
   The BuzzFeed Widget Builder is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or 
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/ >.