README.md in sprite-0.1.4 vs README.md in sprite-0.1.5
- old
+ new
@@ -92,11 +92,11 @@
# defines the base configuration options (file paths, etc, default style, etc)
config:
style: css
- style_output_path: sass/mixins/sprites.sass
+ style_output_path: stylesheets/sprites
image_output_path: images/sprites/
image_source_path: images/
public_path: public/
sprites_class: 'sprites'
class_separator: '-'
@@ -148,18 +148,21 @@
background: url('/images/icons/blue-stars/xlarge.png') no-repeat 0px 96px;
width: 100px;
height: 75px;
}
-We also support mixin syntax via `style: sass_mixin`. If set, sprite will only generate a yml with your specific sprite configurations. It then provides a SASS mixin which you can use in order to mix in these sprites anywhere within your SASS stylesheets.
-
+We also support mixin syntax via `style: sass_mixin`. If set, it will generate a SASS mixin which you can use in order to mix in these sprites anywhere within your SASS stylesheets. For this option, set `style_output_path:` to `stylesheets/sass/_sprites` in order to generate the sass mixin file at `stylesheets/sass/_sprites.sass`
+
+ @import "sass/mixins/sprites.sass"
+
// you can then use your sprite like this
.largebluestar
+sprite("blue-stars", "large")
.mysmallbluestar
+sprite("blue-stars", "small")
+Additional style generators are very easy to add. We have one for `style: sass` and `style: sass_ext`. The `sass_ext` style is a work in progress, as it's attempting to write the sprite data to yml and use a dynamic sass extension to provide the mixin. Eventually, if it works, this will be the default for `sass_mixin`
## Framework Integration?? ##
`sprite` is provided as a command line helper. Deep web framework integration is not implemented at this time, however it shouldn't be needed. Just generate your sprites on your dev machine by running the command line, check in the resulting sprite images and stylesheets to your source control, and deploy!