Merge pull request #20 from github/fire-crema-dependency

Remove crema as a dependency, pageUpdate hook

Author: mtodd

README.md

@@ -9,9 +9,8 @@ into your GitHub-flavored-Markdown user content.
 The Task List feature is actually made of several different components:
 
 * GitHub-flavored-Markdown Filter
-* Model: summarizes and updates task list items
-* Controller: provides the update interface (optional)
-* JavaScript: enables task list behavior, handles AJAX updates, etc
+* Model: summarizes task list items
+* JavaScript: task list update behavior
 * CSS: styles Markdown task list items
 
 ## Installation
@@ -24,36 +23,43 @@ And then execute:
 
     $ bundle
 
-### Rails 3+: Rails Engine?
+### Rails 3+: Railtie method
 
-TBD
-
-### Rails 2.3: Manual.
+``` ruby
+# config/application.rb
+require 'task_list/railtie'
+```
 
-TBD
+### Rails 2.3: Manual method
 
-### CoffeeScript Requirements
+Wherever you have your Sprockets setup:
 
-The following Bower packages are required:
+``` ruby
+Sprockets::Environment.new(Rails.root) do |env|
+  # Load TaskList assets
+  require 'task_list/railtie'
+  TaskList.asset_paths.each do |path|
+    env.append_path path
+  end
+end
+```
 
-* jquery
-* https://github.com/github/crema -- `$.pageUpdate`
-* rails-behavior -- `data-remote`
+If you're not using Sprockets, you're on your own but it's pretty straight
+forward. `task_list/railtie` defines `TaskList.asset_paths` which you can use
+to manage building your asset bundles.
 
-## Usage
+### CoffeeScript Requirements
 
-TBD
+Aside from requiring CoffeeScript, jQuery is the only other requirement.
 
 ## Testing and Development
 
-To run the functional tests in the browser, install the necessary components
-with `script/bootstrap`:
+JavaScript unit tests can be run with `script/testsuite`.
 
-```
-script/bootstrap
-```
+Ruby unit tests can be run with `rake test`.
 
-Then run the server:
+Functional tests are more for manual testing in the browser. To run, install
+the necessary components with `script/bootstrap` then run the server:
 
 ```
 rackup -p 4011

app/assets/javascripts/task_lists.coffee

@@ -5,7 +5,7 @@
 #= provides tasklist:change
 #= provides tasklist:changed
 #
-#= require crema/events/pageupdate
+#= require jquery
 #
 # Enables Task List update behavior.
 #
@@ -39,7 +39,7 @@
 # TaskList updates trigger `tasklist:change` events. If the change is
 # successful, `tasklist:changed` is fired. The change can be canceled.
 #
-# jQuery and crema are required.
+# jQuery is required.
 #
 # ### Methods
 #
@@ -92,11 +92,7 @@
 # ### NOTE
 #
 # Task list checkboxes are rendered as disabled by default because rendered
-# user content is cached without regard for the viewer. We enable checkboxes
-# on `pageUpdate` if the container has a `(textarea).js-task-list-field`.
-#
-# To automatically enable TaskLists, add the `js-task-list-enable` class to the
-# `js-task-list-container`.
+# user content is cached without regard for the viewer.
 
 incomplete = "[ ]"
 complete   = "[x]"
@@ -228,7 +224,3 @@ $.fn.taskList = (method) ->
     disable: disableTaskLists
 
   methods[method || 'enable']($container)
-
-# When the page is updated, enable new TaskList containers.
-$.pageUpdate ->
-  $('.js-task-list-container.js-task-list-enable').taskList()

lib/task_list/version.rb

@@ -1,3 +1,3 @@
 class TaskList
-  VERSION = [0, 3, 0].join('.')
+  VERSION = [0, 4, 0].join('.')
 end