Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/docmars/spriggan
Browse files Browse the repository at this point in the history
  • Loading branch information
Andy Merskin committed Jul 19, 2017
2 parents 7b0a383 + 373f795 commit e7ac60b
Showing 1 changed file with 28 additions and 4 deletions.
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.™
[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.

More about sprites: [CSS Tricks](https://css-tricks.com/css-sprites/)

#### Common use cases
- Icon libraries
- Button and component states (image-based)
- Logos
- Image bundles for advertisements

#### Contributors

Expand All @@ -35,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

0 comments on commit e7ac60b

Please sign in to comment.