favicon_maker 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,58 @@
+FaviconMaker
+============
+
+FaviconMaker aims to ease the tedious process of creating multiple versions of your favicon in different sizes and formats.
+
+The basic idea is to have one image file as source for all the different sizes and or formats (png/ico). If the input folder contains a precomposed file like a visually improved version of the 16x16 favicon.ico this file version will not be generated but the file optionally be copied to the output folder. The remaining versions will still be sourced from the input image defined.
+
+## Install
+### Standalone
+    gem install favicon_maker
+
+### Using Bundler (recommended)
+    ...
+    gem "favicon_maker"
+    ...
+
+## Integration
+### Middleman
+In order to integrate the FaviconMaker effortless into your [Middleman](https://github.com/tdreyno/middleman) project use the following gem: [middleman-favicon-maker](https://github.com/follmann/middleman-favicon-maker)
+### Rails
+Soon to come... Have a look on the basic usage for now.
+
+## Basic Usage
+### Simple
+    require "rubygems"
+    require "favicon_maker"
+    
+    FaviconMaker::Generator.create_versions
+
+Uses the following defaults:
+
+    options = {
+      :versions => [:apple_114, :apple_72, :apple_57, :apple_pre, :apple, :fav_png, :fav_ico],
+      :root_dir => File.dirname(__FILE__),
+      :input_dir => "favicons",
+      :base_image => "favicon_base.png",
+      :output_dir => "favicons_output",
+      :copy => false
+    }
+
+### Advanced 
+(attempted Rails integration, could be used in a Rake task or Capistrano recipe)
+
+    options = {
+      :versions => [:apple_114, :apple_57, :apple, :fav_png, :fav_ico],
+      :root_dir => Rails.root,
+      :input_dir => File.join(Rails.root, "app", "assets", "public"),
+      :base_image => "favico.png",
+      :output_dir => "public",
+      :copy => true
+    }
+    FaviconMaker::Generator.create_versions(options) do |filepath|
+      Rails.logger.info "Created favicon: #{filepath}"
+    end
+
+## Copyright
+
+Copyright (c) 2011 Andreas Follmann. See LICENSE for details.

data/favicon_maker.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Andreas Follmann"]
   #s.email       = [""]
-  #s.homepage    = "https://github.com/tdreyno/middleman-smusher"
+  s.homepage    = "https://github.com/follmann/favicon_maker"
   s.summary     = %q{Create favicon files in various sizes from a base image}
   s.description = %q{Create favicon files in various sizes from a base image}
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module FaviconMaker
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Andreas Follmann
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-31 00:00:00 +01:00
+date: 2011-11-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,11 +40,12 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- README.md
 - favicon_maker.gemspec
 - lib/favicon_maker.rb
 - lib/version.rb
 has_rdoc: true
-homepage: 
+homepage: https://github.com/follmann/favicon_maker
 licenses: []
 
 post_install_message: