middleman-favicon-maker 0.0.4 → 0.0.5

data/LICENSE

@@ -1,7 +1,20 @@
 Copyright (c) 2011 Andreas Follmann
 
-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:
+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 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.
+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

@@ -1,5 +1,5 @@
 middleman-favicon-maker
-============
+=======================
 Generate favicon files in various sizes from a base image in your middleman project.
 
 This gem integrates [FaviconMaker](https://github.com/follmann/favicon_maker) effortless into your [Middleman](https://github.com/tdreyno/middleman) project.
@@ -9,20 +9,31 @@ This gem integrates [FaviconMaker](https://github.com/follmann/favicon_maker) ef
     gem install middleman-favicon-maker
 
 ### Using Bundler (recommended)
-    ...
     gem "middleman-favicon-maker"
-    ...
 
 ## How to integrate into a middleman project
-In your config.rb extend the configure :build block with:
+1. Put a file called favicon_base.png into your source folder (ideally with the dimensions of 114x114 pixels)
+2. In your config.rb extend the configure :build block with:
 
-    configure :build do
-      ...
-      activate :favicon_maker
-      ...
-    end
+        configure :build do
+          ...
+          activate :favicon_maker
+          ...
+        end
 
-### Customise integration
+That results in the following files being created on middleman build:
+
+    build/apple-touch-icon-57x57-precomposed.png
+    build/apple-touch-icon-72x72-precomposed.png
+    build/apple-touch-icon-114x114-precomposed.png
+    build/apple-touch-icon-precomposed.png
+    build/apple-touch-icon.png
+    build/favicon.ico
+    build/favicon.png
+
+**NOTE: The base image will not be copied to the build folder.**
+
+## Customise integration
 You can set the following options for favicon-maker:
 
     :favicon_root_dir  # default: app.root
@@ -30,10 +41,12 @@ You can set the following options for favicon-maker:
     :favicon_output_dir # default: app.build_dir -> build/
     :favicon_base_image # default: "favicon_base.png"
     :favicon_versions # default: ::FaviconMaker::Generator::ICON_VERSIONS.keys
+    :favicon_custom_versions # default: {}
     
     e.g.
     set :favicon_input_dir, "favicons"
+    set :favicon_custom_versions, {:apple_extreme_retina => {:filename => "apple-touch-icon-228x228-precomposed.png", :dimensions => "228x228", :format => "png"}}
 
 ## Copyright
 
-Copyright (c) 2011 Andreas Follmann. See LICENSE for details.
+© 2011 Andreas Follmann. See LICENSE for details.

data/lib/middleman-favicon-maker.rb

@@ -10,7 +10,7 @@ module Middleman
           app.set :favicon_output_dir, app.build_dir
           app.set :favicon_base_image, "favicon_base.png"
           app.set :favicon_versions, ::FaviconMaker::Generator::ICON_VERSIONS.keys
-      
+          
           app.after_build do
             ::FaviconMaker::Generator.create_versions({
               :root_dir => app.settings.favicon_root_dir,
@@ -18,6 +18,7 @@ module Middleman
               :output_dir => app.settings.favicon_output_dir,
               :base_image => app.settings.favicon_base_image,
               :versions => app.settings.favicon_versions,
+              :custom_versions => app.settings.favicon_custom_versions,
             }) do |filepath|
               say_status :generated, filepath.gsub(app.root + "/", "")
             end

data/lib/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module FaviconMaker
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/middleman-favicon-maker.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_runtime_dependency("favicon_maker", ["~>0.0.1"])
+  s.add_runtime_dependency("favicon_maker", ["~>0.0.5"])
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-favicon-maker
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,15 +13,15 @@ date: 2011-11-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: favicon_maker
-  requirement: &70351258343740 !ruby/object:Gem::Requirement
+  requirement: &70296238954840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *70351258343740
+  version_requirements: *70296238954840
 description: Generate favicon files in various sizes from a base image in your middleman
   project
 email: