README.md in jekyll-assets-0.3.4 vs README.md in jekyll-assets-0.3.5

- old
+ new

@@ -13,17 +13,21 @@ - It allows you to minify/compress your JavaScript and CSS assets using compressor you like: YUI, SASS, Uglifier or no compression at all. - It supports JavaScript templates for client-side rendering of strings or markup. JavaScript templates have the special format extension `.jst` and are compiled to JavaScript functions. -- Automaticaly adds MD5 fingerprint suffix for _cache busting_. That means - that your `app.css` will become `app-908e25f4bf641868d8683022a5b62f54.css`. -- [Compass][compass] and [Bourbon][bourbon] built-in support. +- Adds MD5 fingerprint suffix for _cache busting_. That means your `app.css` + will become `app-908e25f4bf641868d8683022a5b62f54.css`. See `cachebust` + configuration option for other variants. +- Produce gzipped versions of assets. See `gzip` configuration option for + details. +- [Compass][compass], [Bourbon][bourbon] and [Neat][neat] built-in support. See "Custom Vendors" below. [compass]: http://compass-style.org/ [bourbon]: http://bourbon.io/ +[neat]: http://neat.bourbon.io/ Jekyll-Assets uses fabulous [Sprockets][sprockets] under the hood, so you may refer to Rails guide about [Asset Pipeline][rails-guide] for detailed information about amazing features it gives you. @@ -280,10 +284,22 @@ ``` Now you can add `@import "bourbon"` in your SASS assets to get Bourbon goodies. +#### Neat Support + +Require `jekyll-assets/neat` to enable, e.g.: + +``` ruby +require "jekyll-assets" +require "jekyll-assets/neat" +``` + +Now you can add `@import "neat"` in your SASS assets to get Neat goodies. + + ## The Directive Processor *Note:* This section extracted from [Sprockets][sprockets] README. Sprockets runs the *directive processor* on each CSS and JavaScript @@ -433,29 +449,35 @@ # source file: _assets/javascripts/app.css # output file: _site/assets/javascriptis/app-4f41243847da693a4f356c0486114bc6.css # output URL: /assets/javascripts/app-4f41243847da693a4f356c0486114bc6.css # cachebust: hard + # + # Specifies list of MIME types that needs to have gzipped versions. + # You can set it to `false` to disable gzipping. Only javascripts and + # stylesheets are gzipped by default. + # + gzip: [ text/css, application/javascript ] ``` -## Contributing - -1. Fork it -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Added some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create new Pull Request - - ## "Th-th-th-that's all folks!" Feel free to follow me on [twitter][twitter], chat via [jabber][jabber] or write an [e-mail][e-mail]. :D [twitter]: https://twitter.com/zapparov [jabber]: xmpp://zapparov@jabber.ru [e-mail]: mailto://ixti@member.fsf.org + + +## Contributing + +1. Fork it +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Added some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create new Pull Request ## License Copyright (C) 2012 Aleksey V Zapparov (http://ixti.net/)