Ready to roll

Author: Nathan Campos

README.md

@@ -1,3 +1,33 @@
 # ascii-image
 
-A Ruby library to convert images into ASCII.
+A Ruby gem to convert images into ASCII for your awesome command-line applications.  
+*This is my first Ruby gem*
+
+
+## Example
+
+Convert an image to ASCII and print it using 20 columns of the console:
+
+    ascii = ASCII_Image.new("file.jpg")
+    ascii.build(20)
+
+
+## License
+
+This library is licensed under the GPLv3 license.
+
+ > ascii-image - A Ruby gem to convert images into ASCII.
+ > Copyright (C) 2012 Nathan Campos
+ > 
+ > This program is free software: you can redistribute it and/or modify
+ > it under the terms of the GNU General Public License as published by
+ > the Free Software Foundation, either version 3 of the License, or
+ > (at your option) any later version.
+ > 
+ > This program is distributed in the hope that it will be useful,
+ > but WITHOUT ANY WARRANTY; without even the implied warranty of
+ > MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ > GNU General Public License for more details.
+ > 
+ > You should have received a copy of the GNU General Public License
+ > along with this program.  If not, see <http://www.gnu.org/licenses/>.

ascii-image.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
     s.name        = "ascii-image"
-    s.version     = "0.0.1"
-    s.date        = '2012-11-03'
+    s.version     = "0.1.0"
+    s.date        = '2012-11-04'
     s.summary     = "Convert images into ASCII"
-    s.description = "A Ruby gem to convert images into ASCII"
+    s.description = "A Ruby gem to convert images into ASCII for your awesome command-line applications"
     s.authors     = ["Nathan Campos"]
     s.email       = "nathanpc@dreamintech.net"
     s.files       = ["lib/ascii-image.rb"]
     s.homepage    = "https://github.com/nathanpc/ascii-image"
-end
+end

lib/ascii-image.rb

@@ -4,7 +4,30 @@
 require 'RMagick'
 require 'rainbow'
 
+# == Summary
+# 
+# This handy Ruby gem will help you to create awesome ASCII art from images
+# for your awesome command-line projects.
+# 
+# == Example
+# 
+#   ascii = ASCII_Image.new("file.jpg")
+#   ascii.build(80)
+# 
+# == Contact
+# 
+# Author:: Nathan Campos (nathanpc@dreamintech.net)
+# Website:: http://about.me/nathanpc
+
 class ASCII_Image
+    # Initialize the ASCII_Image class.
+    # 
+    # An Error is raised if your ImageMagick quantum depth is higher than 8.
+    # 
+    # Arguments:
+    #   file: (String)
+    #   console_width: (Integer)
+    
     def initialize(file, console_width = 80)
         @file = file
         @console_width = console_width
@@ -14,6 +37,13 @@ def initialize(file, console_width = 80)
         end
     end
 
+    # Convert the image into ASCII and print it to the console.
+    # 
+    # An ArgumentError is raised if the +width+ is bigger than the +console_width+
+    # 
+    # Arguments:
+    #   width: (Integer)
+    
     def build(width)
         # Open the image file
         image = Magick::Image.read(@file)[0]