Skip to content

Commit d723ac3

Browse files
committed
README tweak
1 parent e3f3244 commit d723ac3

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ For example, given you have the following setup:
5858
public/
5959
images/
6060
sprites/
61-
black_icons/
61+
black-icons/
6262
stop.png
6363
go.png
6464
back.png
@@ -76,7 +76,7 @@ Running `sprite` with no configuration file will generate the following new file
7676
sprites.css
7777
images/
7878
sprites/
79-
black_icons.png
79+
black-icons.png
8080
weather.png
8181

8282
Any folders within `public/images/sprites/` will get compressed into a merged image file at the same
@@ -128,41 +128,41 @@ you can define any number of destination image files.
128128
align: horizontal
129129
spaced_by: 50
130130
sources:
131-
- icons/blue_stars/small.png
132-
- icons/blue_stars/medium.png
133-
- icons/blue_stars/large.png
134-
- icons/blue_stars/xlarge.png
131+
- icons/blue-stars/small.png
132+
- icons/blue-stars/medium.png
133+
- icons/blue-stars/large.png
134+
- icons/blue-stars/xlarge.png
135135
136-
# creates a public/images/sprites/green_stars.jpg image with
137-
# all the jpg files contained within /images/icons/green_stars/
136+
# creates a public/images/sprites/green-stars.jpg image with
137+
# all the gif files contained within /images/icons/green-stars/
138138
- name: green_stars
139-
format: jpg
139+
format: png
140140
align: vertical
141141
spaced_by: 50
142142
sources:
143-
- icons/green_stars/*.jpg
143+
- icons/green-stars/*.gif
144144

145145
### Style Settings ###
146146

147147
By default, it will use with `style: css` and generate the file at `public/stylesheets/sprites.css`
148148

149-
.sprites.blue_stars_small {
150-
background: url('http://github.com/images/icons/%3Cspan%20class=%22x%20x-first%20x-last%22%3Eblue_stars%3C/span%3E/small.png') no-repeat 0px 0px;
149+
.sprites.blue-stars-small {
150+
background: url('http://github.com/images/icons/%3Cspan%20class=%22x%20x-first%20x-last%22%3Eblue-stars%3C/span%3E/small.png') no-repeat 0px 0px;
151151
width: 12px;
152152
height: 6px;
153153
}
154-
.sprites.blue_stars_medium {
155-
background: url('http://github.com/images/icons/%3Cspan%20class=%22x%20x-first%20x-last%22%3Eblue_stars%3C/span%3E/medium.png') no-repeat 0px 6px;
154+
.sprites.blue-stars-medium {
155+
background: url('http://github.com/images/icons/%3Cspan%20class=%22x%20x-first%20x-last%22%3Eblue-stars%3C/span%3E/medium.png') no-repeat 0px 6px;
156156
width: 30px;
157157
height: 15px;
158158
}
159-
.sprites.blue_stars_large {
160-
background: url('http://github.com/images/icons/%3Cspan%20class=%22x%20x-first%20x-last%22%3Eblue_stars%3C/span%3E/large.png') no-repeat 0px 21px;
159+
.sprites.blue-stars-large {
160+
background: url('http://github.com/images/icons/%3Cspan%20class=%22x%20x-first%20x-last%22%3Eblue-stars%3C/span%3E/large.png') no-repeat 0px 21px;
161161
width: 60px;
162162
height: 30px;
163163
}
164-
.sprites.blue_stars_xlarge {
165-
background: url('http://github.com/images/icons/%3Cspan%20class=%22x%20x-first%20x-last%22%3Eblue_stars%3C/span%3E/xlarge.png') no-repeat 0px 96px;
164+
.sprites.blue-stars-xlarge {
165+
background: url('http://github.com/images/icons/%3Cspan%20class=%22x%20x-first%20x-last%22%3Eblue-stars%3C/span%3E/xlarge.png') no-repeat 0px 96px;
166166
width: 100px;
167167
height: 75px;
168168
}
@@ -171,10 +171,10 @@ We also support mixin syntax via `style: sass_mixin`. If set, sprite will only g
171171

172172
// you can then use your sprite like this
173173
.largebluestar
174-
+sprite("blue_stars", "large")
174+
+sprite("blue-stars", "large")
175175

176176
.mysmallbluestar
177-
+sprite("blue_stars", "small")
177+
+sprite("blue-stars", "small")
178178

179179
## ABOUT `sprite` ##
180180

0 commit comments

Comments
 (0)