From ed24741f2b86ddf845a015afa3dcb02a07173176 Mon Sep 17 00:00:00 2001 From: Andy Merskin Date: Wed, 19 Jul 2017 11:45:19 -0600 Subject: [PATCH 1/3] Update README.md --- README.md | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 882e422..aa48d75 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,37 @@ ![logo.svg][1] -The Celtic batch sprite generator. Created with love at Markit Digital. +#### the Celtic sprite generator + +> - Spriten your day.™ +> - Spriten the load.™ +> - Because, the future is sprite.™ + +Created with love at Markit Digital. [Download Current Release](https://github.com/docmars/spriggan/releases/tag/0.1.0) · macOS ![spriggan.gif][2] +#### What's it do? +- Creates multiple image sprites in batches, in just a few clicks +- Supports entire folder structures of images +- Writes the sprite CSS +- Minifies sprite images to reduce the file size + #### Usage -1. Drag images, or folders of images you want to create sprites out of. -2. Click **Generate All**. -3. Sing a Gaelic tune! +1. Drag a few images (or a few folders of images) you want to create sprites out of. +2. or create new Buckets from scratch and add your images to them. +3. Click **Generate All**. +4. Sing a Gaelic tune! Each of your buckets have been turned into a sprite image (PNG) with its accompanying CSS your developers can use in their project. + +#### What's a sprite? +A sprite is a map of images all compiled together so that developers don't have to include every individual image in their project separately, which causes slowdowns when a site or app loads. Loading just one image is quicker and more efficient. + +#### Common use cases +- Icon libraries +- Button and component states (image-based) +- Logos +- Image bundles for advertisements #### Contributors From aff835a45f73af45473ba9c6bed7f8e4dbc2b897 Mon Sep 17 00:00:00 2001 From: Andy Merskin Date: Wed, 19 Jul 2017 13:06:55 -0600 Subject: [PATCH 2/3] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aa48d75..5541ae0 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ > - Spriten the load.™ > - Because, the future is sprite.™ -Created with love at Markit Digital. +Created with love at Markit Digital [Download Current Release](https://github.com/docmars/spriggan/releases/tag/0.1.0) · macOS @@ -27,6 +27,8 @@ Created with love at Markit Digital. #### What's a sprite? A sprite is a map of images all compiled together so that developers don't have to include every individual image in their project separately, which causes slowdowns when a site or app loads. Loading just one image is quicker and more efficient. +More about sprites: [CSS Tricks](https://css-tricks.com/css-sprites/) + #### Common use cases - Icon libraries - Button and component states (image-based) From 373f7953bfe26c1bd8813d88a3de00f1c30c97d4 Mon Sep 17 00:00:00 2001 From: Andy Merskin Date: Wed, 19 Jul 2017 14:05:00 -0600 Subject: [PATCH 3/3] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5541ae0..9859ccf 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ > - Spriten the load.™ > - Because, the future is sprite.™ -Created with love at Markit Digital - [Download Current Release](https://github.com/docmars/spriggan/releases/tag/0.1.0) · macOS ![spriggan.gif][2] @@ -59,3 +57,5 @@ This project was generated with [electron-vue](https://github.com/SimulatedGREG/ [1]: https://github.com/docmars/spriggan/blob/master/resources/logo.png [2]: https://github.com/docmars/spriggan/blob/master/resources/spriggan.gif + +#### Created, with love, for Markit Digital