Permalink
Browse files

Release notes

  • Loading branch information...
1 parent d8ff38c commit 0eda140bb04b64b49f6fa680f2c38fdf64c85cd1 @kpdecker committed Nov 19, 2012
Showing with 28 additions and 0 deletions.
  1. +28 −0 README.md
View
28 README.md
@@ -7,3 +7,31 @@ Image linking utilities for Stylus.
* Merges duplicated data URIs
* Loads resolution dependent images when available
* Moves non-inlined relative url's into the output directory
+
+
+## Release Notes
+
+### Version 1.0
+
+- Rework the API to support multiple file output from a single stylus execution.
+
+Old stylus plugin-based implementation is still an option using `require('stylus-images').plugins`
+
+New implementations should use the stylus-image object in place of direct stylus calls:
+
+```javascript
+ var stylusImages = require('stylus-images');
+
+ var compiler = stylusImages('some stylus', {
+ images: {
+ limit: 123,
+ resolutions: [1, 2]
+ }
+ });
+ compiler.set('compress', true);
+ compiler.render(function(err, data) {
+ writeFile('css.css', data['1']);
+ writeFile('css@1.5.css', data['1.5']);
+ writeFile('css@2x.css', data['2']);
+ });
+```

0 comments on commit 0eda140

Please sign in to comment.