Portfolio / grublet / README

===================================================
| GRUBLET: A PHP WRAPPER AROUND THE PUNCHFORK API |
===================================================
Thank you for choosing Grublet!

This is my first attempt at writing a library. Please send all of your 
feedback to <adam> at runbymany <dot> com. I've licensed this library as GPL 
v3 or later. I plan on being the only author for quite some time so if you 
would like to discuss this decision and the possibility of licensing it under 
another license then please use my e-mail address to contact me.

As of 09/06/11 the PunchFork API supports the following requests:

1) Recipe Search
2) Random Recipe
3) List of Publishers
4) Generate Search Index
5) Rate Limit Status

I will attempt to "keep up" with the changes to the PunchFork API but to obtain
timely information it is best to visit http://api.punchfork.com.

To use Grublet simply add this directory to your project and include the "Grublet.php" file in your code.

This library is an independent work and NOT SANCTIONED by PunchFork, Inc. or 
any of its affiliates.

PunchFork is Copyright 2011 by PunchFork, Inc.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.