Skip to content

Commit 073a9e9

Browse files
committed
Tweaking Readme and gemspec
1 parent af18cb7 commit 073a9e9

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ All image and style paths should be set relative to the public folder (which is
9494

9595
config:
9696
style: css
97-
style_output_path: sass/mixins/sprites.sass
97+
style_output_path: stylesheets/sprites
9898
image_output_path: images/sprites/
9999
image_source_path: images/
100100
public_path: public/
@@ -150,15 +150,18 @@ By default, it will use with `style: css` and generate the file at `public/style
150150
height: 75px;
151151
}
152152

153-
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.
154-
153+
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`
154+
155+
@import "sass/mixins/sprites.sass"
156+
155157
// you can then use your sprite like this
156158
.largebluestar
157159
+sprite("blue-stars", "large")
158160

159161
.mysmallbluestar
160162
+sprite("blue-stars", "small")
161163
164+
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`
162165

163166
## Framework Integration?? ##
164167

Rakefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Jeweler::Tasks.new do |gemspec|
1616
gemspec.description = "sprite is a rails/merb plugin that generates sprites for css, sass"
1717
gemspec.email = "[email protected]"
1818
gemspec.homepage = "http://github.com/merbjedi/sprite"
19-
gemspec.authors = ["Jacques Crocker", "Richard Huang"]
19+
gemspec.authors = ["Jacques Crocker"]
2020
gemspec.files.exclude '.gitignore'
2121

2222
# removing test files and specs from the gem to save space

sprite.gemspec

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Gem::Specification.new do |s|
77
s.name = %q{sprite}
8-
s.version = "0.1.3"
8+
s.version = "0.1.4"
99

1010
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
1111
s.authors = ["Jacques Crocker", "Richard Huang"]
@@ -31,8 +31,8 @@ Gem::Specification.new do |s|
3131
"lib/sprite/styles.rb",
3232
"lib/sprite/styles/css_generator.rb",
3333
"lib/sprite/styles/sass_generator.rb",
34-
"lib/sprite/styles/sass_if_generator.rb",
3534
"lib/sprite/styles/sass_mixin_generator.rb",
35+
"lib/sprite/styles/sass_yml_generator.rb",
3636
"rails/init.rb",
3737
"sprite.gemspec",
3838
"tasks/sprite_tasks.rake"

0 commit comments

Comments
 (0)