README.md in sprite-0.1.5 vs README.md in sprite-0.1.6
- old
+ new
@@ -75,10 +75,11 @@
- `image_output_path:` defines the folder path where the combined sprite images files are written (defaults to `images/sprites/`)
- `image_source_path:` defines the folder where source image files are read from (defaults to `images/`)
- `public_path:` defines the root folder where static assets live (defaults to `public/`)
- `sprites_class:` defines the class name that gets added to all sprite stylesheet rules (defaults to `sprites`)
- `default_format:` defines the default file image format of the generated files. (defaults to `png`)
+ - `default_spacing:` defines the default pixel spacing between sprites (defaults to 0)
- `class_separator:` used to generated the class name by separating the image name and sprite name (defaults to `-`)
* `images:` section provides an array of configurations which define which image files are built, and where they get their sprites from. each image setup provides the following config options:
- `name:` name of image (required)
- `sources:` defines a list of source image filenames to build the target image from (required). They are parsed by <code>Dir.glob</code>
@@ -99,9 +100,10 @@
image_source_path: images/
public_path: public/
sprites_class: 'sprites'
class_separator: '-'
default_format: png
+ default_spacing: 50
# defines what sprite collections get created
images:
# creates a public/images/sprites/blue_stars.png image with 4 sprites in it