diff --git a/README.md b/README.md index 170c5f0..d2db905 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@ # Fancy Sprites -Fancy sprites is a very minimalistic spriting solution for your web projects based on spritesmith. +Fancy sprites is a very minimalistic spriting solution for your web projects based on [spritesmith](https://github.com/Ensighten/spritesmith). It gives you the flexibility to provide sprite sheets in multiple resolutions. -Sample configuration - +Sample configuration with '1x', '2x' sprite sheets: ``` JavaScript { create: { @@ -28,7 +27,7 @@ Sample configuration } ``` -The task then automatically gathers multiple versions of the same sprite based on the return value of `spriteName`. Here is what the generated SCSS file then looks like: +The task then automatically gathers multiple versions of the same sprite based on the return value of the `spriteName` function. Here is what the generated SCSS file then looks like: ``` SCSS $sprite-first: "1x" 416px 0px 200px 200px 1100px 925px, "2x" 816px 0px 400px 400px 2160px 1810px; @@ -38,8 +37,8 @@ $sprites: "first" $sprite-first, "second" $sprite-second; ``` Files: -- first.png -- first@2x.png -- second.png +- `first.png` +- `first@2x.png` +- `second.png` See fancy-sprites-styles for a SCSS Mixin that consumes this output. \ No newline at end of file