panpainter / featherdust

= Featherdust

* http://featherdust.panpainter.com
* http://github.com/panpainter/featherdust/tree/master
* http://panpainter.lighthouseapp.com/projects/21671/home

== DESCRIPTION:

Featherdust is a simple Twitter gem that grabs and parses data via the Twitter API.

NOTE: This gem does not (and will not) support posting to twitter, adding/removing followers, etc.  This is a data 
grabber only.  If you want more interaction with Twitter, check out the Twitter gem (http://twitter.rubyforge.com) or 
Twitter4R (http://twitter4r.rubyforge.com).

If you have questions (or suggestions), please feel free to shoot them off to mike [at] panpainter [dot] com and I'll be 
happy to help.

== FEATURES/PROBLEMS:

* Takes in a username and an integer and returns a list of Twitter updates.
* Has several display options: plain text, html, and relative and static time outputs

== SYNOPSIS:

  my_statuses = Featherdust.new("panpainter", 5)
  my_statuses.display_status
  
  === Plain Text
  plain_statuses = Featherdust.new("panpainter",5,{:display => "plain"})
  plain_statuses.display_status

== REQUIREMENTS:

* nokogiri
* duration
* net/http
* time

== INSTALL:

* gem sources -a http://gems.github.com (only ever needs to be run once)
* gem install panpainter-featherdust

== LICENSE:

(The MIT License)

Copyright (c) 2008 Michael Tierney

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.