Chris@0: == Gravatar Plugin
Chris@0: 
Chris@0: This plugin provides a handful of view helpers for displaying gravatars 
Chris@0: (globally-recognized avatars). 
Chris@0: 
Chris@0: Gravatars allow users to configure an avatar to go with their email address at
Chris@0: a central location: http://gravatar.com. Gravatar-aware websites (such
Chris@0: as yours) can then look up and display each user's preferred avatar, without
Chris@0: having to handle avatar management. The user gets the benefit of not having to
Chris@0: set up an avatar for each site that they post on.
Chris@0: 
Chris@0: == Installation
Chris@0: 
Chris@0:   cd ~/myapp
Chris@0:   ruby script/plugin install git://github.com/woods/gravatar-plugin.git
Chris@0: 
Chris@0: or, if you're using piston[http://piston.rubyforge.org] (worth it!):
Chris@0: 
Chris@0:   cd ~/myapp/vendor/plugins
Chris@0:   piston import git://github.com/woods/gravatar-plugin.git
Chris@0: 
Chris@0: == Example
Chris@0: 
Chris@0: If you represent your users with a model that has an +email+ method (typical
Chris@0: for most rails authentication setups), then you can simply use this method
Chris@0: in your views:
Chris@0: 
Chris@0:   <%= gravatar_for @user %>
Chris@0:   
Chris@0: This will be replaced with the full HTML +img+ tag necessary for displaying 
Chris@0: that user's gravatar.
Chris@0: 
Chris@0: Other helpers are documented under GravatarHelper::PublicMethods.
Chris@0: 
Chris@0: == Acknowledgments
Chris@0: 
Chris@0: Thanks to Magnus Bergmark (http://github.com/Mange), who contributed the SSL
Chris@0: support in this plugin, as well as a few minor fixes.
Chris@0: 
Chris@0: The following people have also written gravatar-related Ruby libraries:
Chris@0: * Seth Rasmussen created the gravatar gem[http://gravatar.rubyforge.org]
Chris@0: * Matt McCray has also created a gravatar 
Chris@0:   plugin[http://mattmccray.com/svn/rails/plugins/gravatar_helper]
Chris@0: 
Chris@0: == Author
Chris@0: 
Chris@0:   Scott A. Woods
Chris@0:   West Arete Computing, Inc.
Chris@0:   http://westarete.com
Chris@0:   scott at westarete dot com
Chris@0: 
Chris@0: == TODO
Chris@0: 
Chris@0: * Add specs for ssl support
Chris@0: * Finish rdoc documentation