Commits

carkraus committed 5b4d6eb

update readme

  • Participants
  • Parent commits e7998af

Comments (0)

Files changed (1)

 # grunt-glue
 
-A grunt plugin for the glue spriting tool(https://github.com/jorgebastida/glue).
+A grunt plugin for the glue spriting tool([https://github.com/jorgebastida/glue](https://github.com/jorgebastida/glue)).
 
 ## Getting Started
-Install glue. See http://glue.readthedocs.org/en/latest/installation.html.
-
-Install this grunt plugin next to your project's [Gruntfile][getting_started] with: `npm install grunt-glue`
-
-Next, add this line to your project's Gruntfile:
+* Install glue. See [http://glue.readthedocs.org/en/latest/installation.html](http://glue.readthedocs.org/en/latest/installation.html).
+* Install this grunt plugin next to your project's [Gruntfile][getting_started] with: `npm install grunt-glue`
+* Add this line to your project's Gruntfile:
 
 ```javascript
 grunt.loadNpmTasks('grunt-glue');
 ```
+* Configure the glue task for each of your sprite targets, like
+```javascript
+grunt.initConfig({
+  // ...
+  glue: {
+    icons: {
+      src: 'assets/icons',
+      dest: 'assets/icons_built'
+    },
+    buttons: {
+      src: 'assets/buttons',
+      options: '--css=assets/built --img=test/assets/built --less --namespace=btn --optipng'
+    }
+  }
 
-[grunt]: https://github.com/cowboy/grunt
+  // ...
+});
+```
+
 [getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md
 
-## Documentation
-_(Coming soon)_
-
 ## License
 Copyright (c) 2012 Carsten Kraus
 Licensed under the MIT license.