jekyll-asset-pipeline 0.0.1 → 0.0.2

data/README.md

@@ -1,7 +1,14 @@
 # Jekyll Asset Pipeline
 
-Jekyll Asset Pipeline collects, converts and minifies your project’s JavaScript and CSS assets.
+[Jekyll Asset Pipeline](http://www.matthodan.com/2012/11/22/jekyll-asset-pipeline.html) is a powerful asset pipeline for Jekyll.  It collects, converts and minifies JavaScript and CSS assets.  Here are a sample of its features:
 
+- Declaritive dependency management
+- Asset preprocessing and compression
+- MD5 fingerprinting for browser caching
+- Development mode (i.e. no asset compression)
+- Works with Jekyll's auto site regeneration
+
+Jekyll Asset Pipeline adds the ability to write assets in languages such as [CoffeeScript](http://coffeescript.org/), [Sass](http://sass-lang.com/), or any other language you like via [asset converter extensions](#asset-preprocessing).  It also adds the ability to minify assets with Yahoo's [YUI Compressor](http://developer.yahoo.com/yui/compressor/), Google's [Closure Compilier](https://developers.google.com/closure/compiler/), or any other compression library via [asset compressor extensions](#asset-compression).
 
 ## Table of Contents
 
@@ -10,6 +17,8 @@ Jekyll Asset Pipeline collects, converts and minifies your project’s JavaScrip
 - [Asset Preprocessing](#asset-preprocessing)
 - [Templates](#templates)
 - [Configuration](#configuration)
+- [Contribute](#contribute)
+- [Credits](#credits)
 
 ## Getting Started
 
@@ -34,15 +43,15 @@ Add a "_assets" folder to your project and copy your JavaScript and CSS assets i
 In the HTML "head" section of your default layout (or other HTML page) of your Jekyll site, add one or both of the following [Liquid](http://liquidmarkup.org/) blocks and replace "foo" and "bar" with your asset files.  These blocks will be converted into HTML "link" and "script" tags that point to the bundled asset files.  The manifest must be a properly formatted YAML array and must include paths to your raw assets from the root folder of your project.
 
 ``` html
-{% raw %}{% css_asset_tag global %}
+{% css_asset_tag global %}
 - /_assets/foo.css
 - /_assets/bar.css
-{% endcss_asset_tag %}{% endraw %}
+{% endcss_asset_tag %}
 
-{% raw %}{% javascript_asset_tag global %}
+{% javascript_asset_tag global %}
 - /_assets/foo.js
 - /_assets/bar.js
-{% endjavascript_asset_tag %}{% endraw %}
+{% endjavascript_asset_tag %}
 ```
 
 > *The above example will create two bundles, a CSS bundle named "global-md5hash.css" and a JavaScript bundle named "global-md5hash.js" that include their respective assets per the manifest.*
@@ -152,7 +161,7 @@ That's it!  Your asset pipeline should have converted any CoffeeScript assets in
 
 ### SASS
 
-You probably get the gist of how compressors work, but I thought I'd add an example showing how to add a SASS converter as well.
+You probably get the gist of how converters work, but I thought I'd add an example showing how to add a SASS converter as well.
 
 ``` ruby
 module JekyllAssetPipeline
@@ -223,8 +232,9 @@ You can contribute to the Jekyll Asset Pipeline by submitting a pull request [vi
 Key areas that I have identified for future improvement include:
 
 - __Tests, tests, tests.__  I'm embarassed to say that I didn't write a single test while building Jekyll Asset Pipeline.  This started as a hack for my blog and quickly grew into a library as I tweaked it to support my own needs.
-- __Handle remote assets.__ Right now, Jekyll Asset Bundler does not provide any way to include remote assets in bundles unless you save them locally before generating your site.  Moshen's [Jekyll Asset Bundler](https://github.com/moshen/jekyll-asset_bundler) allows you to include remote assets, which I thought was pretty interesting.  That said, I think it is generally better to keep remote assets separate so that they load asynchronously.
-- __Documentation.__ I wrote this readme to introduce people to Jekyll Asset Pipeline, but there should be a set of docs located on Github that can be better maintained.
+- __CDN support.__ Jekyll Asset Pipeline should support using a CDN to host your assets.
+- __Handle remote assets.__ Right now, Jekyll Asset Pipeline does not provide any way to include remote assets in bundles unless you save them locally before generating your site.  Moshen's [Jekyll Asset Bundler](https://github.com/moshen/jekyll-asset_bundler) allows you to include remote assets, which I thought was pretty interesting.  That said, I think it is generally better to keep remote assets separate so that they load asynchronously.
+- __Documentation.__ I wrote this readme to introduce people to Jekyll Asset Pipeline, but there should be better organized docs that can be more easily maintained.
 - __Successive preprocessing.__ Currently you can only preprocess a file once.  It would be better if you could run an asset through multiple preprocessors before it gets compressed and bundled.
 
 Feel free to [message me on GitHub](http://github.com/matthodan) if you want to run an idea by me.
@@ -237,3 +247,6 @@ Jekyll Asset Bundler *almost* covered all of my needs when I set out to find an
 
 I also have to give credit to [Mojombo](https://github.com/mojombo) for creating [Jekyll](https://github.com/mojombo/jekyll) in the first place.
 
+---
+
+Like this project?  You may want to read [my blog](http://www.matthodan.com).

data/lib/jekyll_asset_pipeline.rb

@@ -9,6 +9,7 @@ require 'jekyll'
 require 'liquid'
 
 # Jekyll extensions
+require 'jekyll_asset_pipeline/version'
 require 'jekyll_asset_pipeline/extendable'
 require 'jekyll_asset_pipeline/asset_file'
 require 'jekyll_asset_pipeline/bundler'
@@ -23,8 +24,6 @@ require 'jekyll_asset_pipeline/css_asset_tag'
 require 'jekyll_asset_pipeline/javascript_asset_tag'
 
 module JekyllAssetPipeline
-  VERSION = '0.0.1'
-
   # Default configuration settings for Jekyll Asset Bundler
   # Strings used for keys to play nice when merging with _config.yml
   DEFAULTS = {

data/lib/jekyll_asset_pipeline/version.rb

@@ -0,0 +1,3 @@
+module JekyllAssetPipeline
+  VERSION = '0.0.2'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-asset-pipeline
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -59,11 +59,13 @@ files:
 - lib/jekyll_asset_pipeline/template.rb
 - lib/jekyll_asset_pipeline/templates/css_tag_template.rb
 - lib/jekyll_asset_pipeline/templates/javascript_tag_template.rb
+- lib/jekyll_asset_pipeline/version.rb
 - lib/jekyll_asset_pipeline.rb
 - LICENSE
 - README.md
 homepage: http://github.com/matthodan/jekyll-asset-pipeline
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: