howkast 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/GPL-LICENSE

@@ -0,0 +1,278 @@
+       GNU GENERAL PUBLIC LICENSE
+           Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+          Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+        GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+          NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+group :production do
+  gem "activesupport", ">= 3.0.3"
+  gem "httparty", ">= 0.6.1"
+  gem "named-parameters", ">= 0.0.22"
+end
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "cucumber", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    builder (3.0.0)
+    crack (0.1.8)
+    cucumber (0.10.0)
+      builder (>= 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.3.3)
+      json (~> 1.4.6)
+    git (1.2.5)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    named-parameters (0.0.22)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    term-ansicolor (1.0.5)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0.3)
+  bundler (~> 1.0.0)
+  cucumber
+  httparty (>= 0.6.1)
+  jeweler (~> 1.5.2)
+  named-parameters (>= 0.0.22)
+  rcov
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+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.

data/README.md

@@ -0,0 +1,272 @@
+This gem implements Ruby bindings for the [Howcast](http://howcast.com) API.
+
+From Howcast's [About Us](http://info.howcast.com/about) page:
+
+> Howcast empowers people with engaging, useful how-to information wherever, 
+> whenever they need to know how. 
+> 
+> Known for high-quality content, Howcast streams tens of millions of videos 
+> every month across its multi-platform distribution network. Approaching two 
+> million downloads across iPhone, iPad, Android, and BlackBerry phones, Howcast 
+> is the #1 mobile app for instructional content -- wherever you are.
+
+Install
+-------
+
+    gem install howkast
+
+Configure
+---------
+Most of the service requests require an API key. You can either set this when
+you create an instance of `Howkast::API`:
+
+    howcast = Howkast::API.new :api_key => 'YOUR-API-KEY'
+    howcast.categories
+
+Or create a configuration that file and set it by invoking the `Howkast::configure`
+method:
+
+    # create the configuration file
+    cat > ~/.howkast <<EOF
+    :api_key: YOUR-API-KEY
+    EOF
+    
+    # now use it
+    require 'rubygems'
+    require 'yaml'
+    require 'howkast'
+    
+    Howkast::configure YAML.load File.read('~/.howkast')
+    howcast = Howkast::API.new
+    howcast.categories
+
+Quickstart
+----------
+
+    require 'rubygems'
+    require 'yaml'
+    begin
+      require 'howkast'
+    rescue LoadError
+      $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+      require 'howkast'
+    end
+
+    # configure
+    Howkast::configure YAML.load File.read('.howkast')
+
+    # create instance
+    howcast = Howkast::API.new
+
+    # alternative instantiation
+    # howcast = Howkast::API.new :api_key => 'YOUR-HOWCAST-API-KEY'
+
+    # search for jujitsu how-to videos
+    search = howcast.search :query => 'jujitsu'
+
+    # get detail for the first video listed in the search
+    video_id = search.videos.first.id
+    video    = howcast.video :id => video_id
+    puts video.title
+    puts video.embed
+
+    # find out what other videos where uploaded by the same user
+    username = video.username
+    user     = howcast.user :id => username, :resource => :videos
+    puts user.title
+    user.videos.each do |video|
+      puts "- #{video.id}\t#{video.title}"
+    end
+
+    # list user's favorite videos
+    user = howcast.user :id => username, :resource => :favorites
+    puts user.title
+    user.videos.each do |video|
+      puts "- #{video.id}\t#{video.title}\t#{video.description}"
+    end
+
+    # list user's playlists
+    user = howcast.user :id => username, :resource => :playlists
+    puts user.title
+    user.playlists.each do |video|
+      puts "- #{video.id}\t#{video.title}"
+    end
+
+    # list available categories
+    categories = howcast.categories
+    categories.each do |category|
+      puts "#{category.id}\t#{category.name}"
+    end
+
+    # get details about a category
+    category = howcast.category :id => categories.first.id
+    puts category.name
+    category.subcategories.each do |category|
+      puts "- #{category.id}\t#{category.name}"
+    end
+
+    # list the videos in a playlist
+    playlist = howcast.playlist :id => '4261'
+    puts playlist.title
+    puts playlist.description
+    playlist.videos.each do |video|
+      puts "- #{video.id}\t#{video.title}"
+    end
+
+Services
+--------
+To identify what services are supported, you can invoke the `services` class 
+method from the `Howkast::API` class:
+
+    Howkast::API.services  # => [:video, :videos, :search, :user, :playlist, :category, :categories]
+  
+At the time of this writing, this gem implements all of the services listed in 
+the [Howcast API Documentation](http://groups.google.com/group/howcast-developers/web/api-documentation)
+
+The current implementation is that each service expects a `Hash` that names 
+the parameters required to fulfill the request. The acceptable parameters
+(with a minor adjustments to make the parameter names consistent) closely
+match the documented service signatures.
+
+Here are some examples to illustrate the service calls. Notice that the `format` 
+parameter does not need to be specified and that the `api_key` only needs to 
+be set at configuration or when the `Howkast::API` object is created:
+
+### Get Video
+
+    # GET http://www.howcast.com/videos/<video_id>.<format>?api_key=<api_key>
+    howcast.video :id => 6570
+    
+### List Videos
+
+    # GET http://www.howcast.com/videos/<sort>/<filter>/<category>.<format>?api_key=<api_key>
+    howcast.videos :sort => :top_rated, :filter => :howcast_studios, :page => 5
+
+### Search Videos
+
+    # GET http://www.howcast.com/search.<format>?q=<query>&view=video&api_key=<api_key> 
+    howcast.search :query => 'jujitsu'
+    
+### List Top-Level Categories
+    
+    # GET http://www.howcast.com/categories.<format>?api_key=<api_key>    
+    howcast.categories
+
+Anyway, you get the idea. 
+
+Read the [Howcast API Documentation](http://groups.google.com/group/howcast-developers/web/api-documentation)
+for details.
+
+Models
+------
+The return value of a service request is an instance of `Howkast::Model` - the
+actual type returned depends on the service invoked. 
+
+The rule to determine the type of the response is:
+
+1. The name of the service in singular form dictates the name of the model 
+   (eg: `video` returns `Howkast::Model::Video`)
+2. If the service name is in plural form, then an `Array` of the expected
+   model is returned.
+   
+The `Howkast::Model` instance returned will have the appropriate attributes
+as described in the [Howcast API Documentation](http://groups.google.com/group/howcast-developers/web/api-documentation)
+
+You can examine the list of attributes by invoking the `#instance_attributes`
+method of the returned model:
+
+    video = howcast.video :id => 6570
+    video.class                # => Howkast::Model::Video
+    video.instance_attributes  # => [:id, :category_id, :category_hierarchy, :easy_steps, :badges, :created_at, :filename, :tags, :title, :description, :permalink, :edit_url, :state, :duration, :width, :height, :embed, :rating, :username, :thumbnail_url, :views, :content_rating, :overlay, :ingredients, :markers, :related_videos, :comments]
+
+And of course examine each attribute as needed:
+
+    video.category_hierarchy   # => Array of Howkast::Model::Category
+    video.title                # => "How To Drive a Stick Shift" 
+    video.related_videos       # => Array of Howkast::Model::Video
+    video.markers              # => Array of Howkast::Model::Marker
+    video.markers.first.type   # => Step
+
+Errors
+------
+If a service request fails then a `Howkast::Error::RequestError` error type is
+raised. The actual type raised depends on the error.
+
+The following shows several service calls, any one of which may raise an 
+error, along with possible ways to deal with the error:
+
+    howcast = Howkast::API.new
+    begin
+      howcast.user :id => "kreektrebano", :resource => :videos
+      howcast.user :id => "jurisgalang",  :resource => :favorite
+      howcast.videos :sort   => :most_recent, 
+                     :filter => :all, 
+                     :page   => 99999999
+      howcast.categories
+    rescue Howkast::Error::UserNotFound
+      # ignore
+    rescue Howkast::Error::HTTP404
+      # ignore but log, this is raised if the resource requested is not found;
+      # eg: specifying a :resource that is not supported, or the :page requested
+      # does not exist
+    rescue Howkast::Error::InvalidAPIKey
+      # the service call requires registration and a valid API key to work
+    rescue Howkast::Error::HTTP500
+      # ignore but log and file a bug at support+api@howcast.com 
+    end
+
+Of the above `Howkast::Error::UserNotFound` and `Howkast::Error::HTTP404` are 
+most likely benign.
+
+Read the **HTTP Status Codes and Errors** section of the [Howcast API Documentation](http://groups.google.com/group/howcast-developers/web/api-documentation)
+for details on the types of errors that may be encountered.
+
+Gotchas
+-------
+At the moment, this gem is intended for `Ruby 1.9.x` use only.
+
+Currently, Howcast responds with an HTTP500 error when the `:q` parameter 
+value is empty the `#search` service plugs this parameter with something that
+*might not* exist and hopefully it returns an appropriate search result (ie: 
+an empty list)
+
+Download
+--------
+You can download this project in either
+[zip](http://github.com/jurisgalang/howkast/zipball/master) or
+[tar](http://github.com/jurisgalang/howkast/tarball/master") formats.
+
+You can also clone the project with [Git](http://git-scm.com)
+by running: 
+
+    git clone git://github.com/jurisgalang/howkast
+
+Note on Patches/Pull Requests
+-----------------------------
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version 
+  unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have 
+  your own version, that is fine but bump version in a commit by itself I can 
+  ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Releases
+--------
+Please read the `RELEASENOTES` file for the details of each release. 
+
+In general: patch releases will not include breaking changes while releases 
+that bumps the major or minor components of the version string may or may not 
+include breaking changes.
+
+Author
+------
+[Juris Galang](http://github.com/jurisgalang/)
+
+License
+-------
+Dual licensed under the MIT or GPL Version 2 licenses.  
+See the MIT-LICENSE and GPL-LICENSE files for details.
+
+Copyright (c) 2010 Juris Galang. All Rights Reserved.