iconoclast 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,25 +1,39 @@
 = iconoclast
 
-Description goes here.
-
-In application_controller.rb:
-helper Iconoclast::IconHelper
-
-In your views:
-<%= icon 'name' %>
-<%= icon 'name', 'alt text' %>
-<%= icon 'name', 'alt text', { :border => 1 } %>
-
-== 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.
+The Iconoclast gem provides an easy way to install iconsets (currently the Famfamfam 'silk' and 'flags' iconsets are included).
+
+= Installation
+
+The iconoclast gem is hosted on gemcutter.org, so you will first need to configure your gem system to pull from gemcutter:
+  $ gem install gemcutter
+  $ gem tumble
+
+Once you have configured gemcutter:
+  $ gem install iconoclast
+
+= Usage
+
+Install iconsets into your rails app's public directory:
+
+  $ cd /path/to/railsapp
+  $ iconify
+
+Running iconify without any arguments installs the famfamfam silk iconset by default. You can specify additional iconsets as well:
+  $ iconify --set=flags
+
+Once your icons are installed, activate the helper methods by adding the following line to your application_controller.rb:
+  helper Iconoclast::IconHelper
+
+Then use the icons in your views:
+  <%= icon 'name' %>
+  <%= icon 'name', 'alt text' %>
+  <%= icon 'name', 'alt text', { :border => 1 } %>
 
 == Copyright
 
 Copyright (c) 2009 Eric Dennis. See LICENSE for details.
+
+This package also contains iconsets from Famfamfam:
+http://www.famfamfam.com/lab/icons/
+
+The Famfamfam iconsets are provided under the Creative Commons Attribution 2.5 License (http://creativecommons.org/licenses/by/2.5/).

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/features/version.feature

@@ -5,4 +5,4 @@ Feature: Version
   
   Scenario: Get application version
     When I call the Iconoclast version method
-    Then the result should be 0.1.0
+    Then the result should be 0.1.1

data/iconoclast.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{iconoclast}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Dennis"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: iconoclast
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Eric Dennis