Permalink
Browse files

update readme and add more things to ignore as well

  • Loading branch information...
1 parent d52205e commit c6289ac0bcf80fcbdb6dcf32465d080068f164a7 @vanntastic committed Dec 10, 2009
Showing with 24 additions and 3 deletions.
  1. +1 −0 .gitignore
  2. +21 −1 README.rdoc
  3. +2 −2 Rakefile
View
@@ -3,3 +3,4 @@
coverage
rdoc
pkg
+*.gemspec
View
@@ -1,7 +1,27 @@
= imgur
-Description goes here.
+A simple ruby interface to the imgur image hosting service (http://imgur.com). This is a nice alternative to uploading images and not having to deal with RMagick bs.
+== Requirements
+
+* Grab a imgur api key : http://imgur.com/register/api/
+
+== Examples
+
+ # Uploading an image to imgur from the filesystem
+
+ img = Imgur::API.new 'YOURAPIKEY'
+ uploaded_img = img.upload_file '/path/to/your/test.jpg'
+ # should return a hash like:
+ # => {"small_thumbnail"=>"http://imgur.com/NfuKFs.png",
+ "original_image"=>"http://imgur.com/NfuKF.png",
+ "large_thumbnail"=>"http://imgur.com/NfuKFl.png",
+ "delete_hash"=>"VAiPkk5NoQ", "imgur_page"=>"http://imgur.com/NfuKF",
+ "delete_page"=>"http://imgur.com/delete/VAiPkk5NoQ",
+ "image_hash"=>"NfuKF"}
+ # now you can do something like (if you're using rails):
+ <%= image_tag uploaded_img["small_thumbnail"] %>
+
== Note on Patches/Pull Requests
* Fork the project.
View
@@ -4,12 +4,12 @@ require 'rake'
begin
require 'jeweler'
Jeweler::Tasks.new do |gem|
- gem.name = "imgur"
+ gem.name = "vanntastic-imgur"
gem.summary = %Q{Imgur API interface}
gem.description = %Q{An interface to the Imgur API}
gem.email = "jdp34@njit.edu"
gem.homepage = "http://github.com/jdp/imgur"
- gem.authors = ["Justin Poliey"]
+ gem.authors = ["Justin Poliey","Vann Ek"]
gem.add_development_dependency "bacon", ">= 1.1.0"
gem.add_development_dependency "yard", ">= 0.2.3.5"
gem.add_development_dependency "curb", ">= 0.5.4.0"

0 comments on commit c6289ac

Please sign in to comment.