knockout-assets 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Version 0.0.1
+
+First commit.

data/README.md

@@ -1,3 +1,41 @@
 # Knockout Assets
 
-A gem to generate paths for knockout templates using the asset pipeline.
+[Knockout Assets](https://github.com/hlascelles/knockout-assets) is a Rails gem that generates full asset URL paths for assets in the asset pipeline.
+It also supplies simple bindings for using assets in [Knockout](http://knockoutjs.com/) templates. This makes it very useful for applications that use
+[Knockout](http://knockoutjs.com/) and CDNs.
+
+## Usage
+
+Install:
+
+    gem 'knockout-assets'
+
+Add the loader in yout application.html.erb:
+
+    <%= knockout_assets %>
+
+Then use in a template:
+
+    <img data-bind="img: 'person.gif'">
+
+## Why?
+
+Asset URLs change depending on how they are served up. In production, assets coming from a CDN have a URL generated at compile time. The standard Rails way
+of solving this is to use an _image_tag_, which renders the right URL. However, since Knockout templates are rendered client side, they don't have access to
+this method, unless the templates are generated in the first place using erb or haml.
+
+Using [Knockout Assets](https://github.com/hlascelles/knockout-assets) has three advantages over using a standard _image_tag_ in knockout templates.
+
+* The knockout templates files need not be processed on the server side at all. This means that testing them (for example with [Jasmine](http://pivotal.github.io/jasmine) becomes possible).
+* The templates may be served up from a CDN using [Knockout.js-External-Template-Engine](https://github.com/ifandelse/Knockout.js-External-Template-Engine).
+* The images are preloaded by default so templates render with the correct layout instantly (but this can be optionally disabled).
+
+## Options
+
+Exclude some images using a regex
+
+    <%= knockout_assets(exclude: /im.*\//) %>
+
+Disable preloading images
+
+    <%= knockout_assets(preload: false) %>

data/lib/knockout/assets/version.rb

@@ -1,3 +1,3 @@
 module KnockoutAssets
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/knockout-assets.rb

@@ -0,0 +1 @@
+require_relative 'knockout/assets'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knockout-assets
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -40,7 +40,9 @@ files:
 - lib/knockout/assets/engine.rb
 - lib/knockout/assets/version.rb
 - lib/knockout/assets.rb
+- lib/knockout-assets.rb
 - README.md
+- CHANGELOG.md
 homepage: https://github.com/hlascelles/knockout-assets
 licenses: []
 post_install_message: