Permalink
Browse files

Updated READNE for modules

  • Loading branch information...
1 parent cc5ccfa commit b127983cbad7f1628bcdda54964e92737c668854 Kevin Malakoff committed Sep 14, 2012
View
9 README.md
@@ -24,6 +24,15 @@ Please see the [release notes](https://github.com/kmalakoff/knockback-navigators
If you have some production quality transitions that you'd like to submit to the library, please [let me know](http://kmalakoff.github.com/knockback/issues).
+###Module Loading
+
+Knockback-Navigators.js is compatible with Require.js and AMD module loading. Module names:
+
+* 'knockback-page-navigator-panes' - knockback-page-navigator-panes.js. Comes bundled with knockback-pane-navigator.js
+* 'knockback-page-navigator-simple' - knockback-page-navigator-simple.js.
+* 'knockback-pane-navigator-simple' - knockback-pane-navigator.js.
+* 'knockback-sample-transitions-jquery' - knockback-sample-transitions-jquery.js.
+
### Dependencies
* You will need to provide a DOM manipulation library like [jQuery](http://jquery.com/) or [Zepto](http://zeptojs.com/) or [XUI](http://xuijs.com/) (XUI: tween animations not supported).
View
4 test/knockback-page-navigator-panes/test-amd.coffee
@@ -3,8 +3,8 @@ $(document).ready( ->
# Knockback and depdenencies
require(['underscore', 'backbone', 'knockout', 'knockback', 'knockback-page-navigator-panes'], (_, Backbone, ko, kb) ->
- _ or (_ = kb._)
- Backbone or (Backbone = kb.Backbone)
+ _ or= @_
+ Backbone or= @Backbone
test("TEST DEPENDENCY MISSING", ->
ok(!!_, '_'); ok(!!Backbone, 'Backbone'); ok(!!ko, 'ko'); ok(!!kb, 'kb'); ok(!!kb.PageNavigatorPanes, 'kb.PageNavigatorPanes')
View
4 test/knockback-page-navigator-simple/test-amd.coffee
@@ -3,8 +3,8 @@ $(document).ready( ->
# Knockback and depdenencies
require(['underscore', 'backbone', 'knockout', 'knockback', 'knockback-page-navigator-simple'], (_, Backbone, ko, kb) ->
- _ or (_ = kb._)
- Backbone or (Backbone = kb.Backbone)
+ _ or= @_
+ Backbone or= @Backbone
test("TEST DEPENDENCY MISSING", ->
ok(!!_, '_'); ok(!!Backbone, 'Backbone'); ok(!!ko, 'ko'); ok(!!kb, 'kb'); ok(!!kb.PageNavigatorSimple, 'kb.PageNavigatorSimple')
View
4 test/knockback-pane-navigator/test-amd.coffee
@@ -3,8 +3,8 @@ $(document).ready( ->
# Knockback and depdenencies
require(['underscore', 'backbone', 'knockout', 'knockback', 'knockback-pane-navigator'], (_, Backbone, ko, kb) ->
- _ or (_ = kb._)
- Backbone or (Backbone = kb.Backbone)
+ _ or= @_
+ Backbone or= @Backbone
test("TEST DEPENDENCY MISSING", ->
ok(!!_, '_'); ok(!!Backbone, 'Backbone'); ok(!!ko, 'ko'); ok(!!kb, 'kb'); ok(!!kb.PaneNavigator, 'kb.PaneNavigator')

0 comments on commit b127983

Please sign in to comment.