Merge pull request #586 from jooby-project/svg-sprites

Update svg-sprites to npm3 and fix Windows git checkout

Author: jknack

jooby-assets-svg-sprites/src/main/resources/dr-svg-sprites/README.md

@@ -112,7 +112,7 @@ Type: `String`
 Default value: `""`
 Optional
 
-The path where to built a preview page. 
+The path where to built a preview page.
 
 If the filename part (ending in `.html`) is omitted it will be built from `options.prefix`, `options.name` and  `"sprite"`.
 
@@ -127,7 +127,7 @@ Destination path of the generated stylesheet.
 If a filename part is omitted it will get built from `options.cssPrefix`, `options.name`, `"sprite"` and `options.cssSuffix`.
 
 If left blank only svg sprites and png fallbacks are generated.
-			
+
 #### options.prefix
 Type: `String`
 Default value: `""`
@@ -158,14 +158,14 @@ Type: `String`
 Default value: `".svg"`
 Optional
 
-Defines a prefix for selectors to target svg sprites. 
+Defines a prefix for selectors to target svg sprites.
 
 #### options.cssPngPrefix
 Type: `String`
 Default value: `""`
 Optional
 
-Defines a prefix for selectors to target png sprites. 
+Defines a prefix for selectors to target png sprites.
 
 **Note:** If both `options.cssSvgPrefix` and `options.cssPngPrefix` are empty strings a multiple-background progressive enhancement is used:
 
@@ -390,8 +390,8 @@ Per default the following plugins are disabled: `moveGroupAttrsToElems`,  `colla
 Type: `Object`
 Optional
 
-This options let's you customise the attributes on the root svg tag in the sprite. 
-Attributes with falsy values (`false`, `null`, `0` etc) will be omitted from the ouput. 
+This options let's you customise the attributes on the root svg tag in the sprite.
+Attributes with falsy values (`false`, `null`, `0` etc) will be omitted from the ouput.
 `viewBox`, `width`, `height` and xml namespaces are all handled automatically - no need to add them here.
 
 ```js
@@ -419,6 +419,13 @@ svgAttributes: {
 
 ## Changelog
 
+### 1.0.0
+
+Changes:
+
+* Now requires ES6 support (Node 5+).
+* Updated to svg2png@4.0.0.
+
 ### 0.9.31
 
 Fixed:

jooby-assets-svg-sprites/src/main/resources/dr-svg-sprites/TROUBLESHOOTING.md

@@ -1,28 +1,28 @@
-## Troubleshooting
-
-### Building sprites
-
-#### If the sprites are generated are empty/blank
-
-A. Make sure your config (`options.spriteElementPath`) is pointing to the folder containing your source svg files.
-
-B. If you are using Adobe Illustrator to produce or save your source svg files - ensure the `Responsive` option in the "More Options"panel is **unticked**:
-
-![airesponsiveoption](https://cloud.githubusercontent.com/assets/868834/3855442/28f33768-1ee5-11e4-89db-838b38425568.jpg)
-
-#### If your sprite looks garbled
-
-This is most likely due to one or more [plugins](https://github.com/svg/svgo/tree/master/plugins) in the svg minifier ([svgo](https://github.com/svg/svgo)) used in the sprite builder. If you run into those edge cases disabling plugins can be done via [`options.svgo`](https://github.com/drdk/dr-svg-sprites#optionssvgo). At default the following plugins are disabled: `moveGroupAttrsToElems`,  `collapseGroups` and `removeUselessStrokeAndFill`.
-If you are unable to find the plugins causing the problem create an issue here and submit as much relevant data as possible.
-
-### In browsers
-
-#### If your sprite isn't displayed - or is very pixelated
-
-Most devices have a maximum allowed buffer for images - if that buffer is exceeded you might experience your sprite either not getting displayed at all - or it getting downsampled.
-It's hard to give precise numbers as the maximum buffer varies from device to device - but for iOS it's 3 megapixels (3 * 1024 * 1024 = 3,145,728 pixels) for devices with less than 256mb ram and 5 megapixels for devices with more.
-As long as your sprite width times height is below the 3 megapixel range you should be good.
-
-References:
-
+## Troubleshooting
+
+### Building sprites
+
+#### If the sprites are generated are empty/blank
+
+A. Make sure your config (`options.spriteElementPath`) is pointing to the folder containing your source svg files.
+
+B. If you are using Adobe Illustrator to produce or save your source svg files - ensure the `Responsive` option in the "More Options"panel is **unticked**:
+
+![airesponsiveoption](https://cloud.githubusercontent.com/assets/868834/3855442/28f33768-1ee5-11e4-89db-838b38425568.jpg)
+
+#### If your sprite looks garbled
+
+This is most likely due to one or more [plugins](https://github.com/svg/svgo/tree/master/plugins) in the svg minifier ([svgo](https://github.com/svg/svgo)) used in the sprite builder. If you run into those edge cases disabling plugins can be done via [`options.svgo`](https://github.com/drdk/dr-svg-sprites#optionssvgo). At default the following plugins are disabled: `moveGroupAttrsToElems`,  `collapseGroups` and `removeUselessStrokeAndFill`.
+If you are unable to find the plugins causing the problem create an issue here and submit as much relevant data as possible.
+
+### In browsers
+
+#### If your sprite isn't displayed - or is very pixelated
+
+Most devices have a maximum allowed buffer for images - if that buffer is exceeded you might experience your sprite either not getting displayed at all - or it getting downsampled.
+It's hard to give precise numbers as the maximum buffer varies from device to device - but for iOS it's 3 megapixels (3 * 1024 * 1024 = 3,145,728 pixels) for devices with less than 256mb ram and 5 megapixels for devices with more.
+As long as your sprite width times height is below the 3 megapixel range you should be good.
+
+References:
+
 * [Know iOS Resource Limits](https://developer.apple.com/library/safari/documentation/AppleApplications/Reference/SafariWebContent/CreatingContentforSafarioniPhone/CreatingContentforSafarioniPhone.html#//apple_ref/doc/uid/TP40006482-SW15)