Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
(The MIT License)

Copyright (c) 2015-present Waysact Pty Ltd

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 changes: 26 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,31 @@
[![npm](https://img.shields.io/npm/v/webpack-spritesmith.svg)](https://www.npmjs.com/package/webpack-spritesmith)
[![GitHub issues](https://img.shields.io/github/issues/mixtur/webpack-spritesmith.svg)](https://github.com/mixtur/webpack-spritesmith/issues)
[![GitHub forks](https://img.shields.io/github/forks/mixtur/webpack-spritesmith.svg)](https://github.com/mixtur/webpack-spritesmith/network)
[![GitHub stars](https://img.shields.io/github/stars/mixtur/webpack-spritesmith.svg)](https://github.com/mixtur/webpack-spritesmith/stargazers)
[![GitHub license](https://img.shields.io/github/license/mixtur/webpack-spritesmith.svg)](https://github.com/mixtur/webpack-spritesmith)

# webpack-spritesmith

Webpack plugin that converts set of images into a spritesheet and SASS/LESS/Stylus mixins, using
[spritesmith](https://github.com/Ensighten/spritesmith) and [spritesheet-templates](https://github.com/twolfson/spritesheet-templates)

All ideas are shamelessly taken from [gulp.spritesmith](https://github.com/twolfson/gulp.spritesmith).


### Install

Install with npm:

```bash
npm install --save-dev webpack-spritesmith
```

Install with yarn:

```bash
yarn add webpack-spritesmith --dev
```

### Example

Let's say you have following folder structure
Expand Down Expand Up @@ -200,5 +221,9 @@ So the way generated image is accessed from generated API at the moment has to b
}

```

- `logCreatedFiles` optional. When set to `true` will console.log list of created files.

## License

MIT (see [LICENSE](LICENSE))