Permalink
Browse files

Updated readme.md

  • Loading branch information...
1 parent a1c2b97 commit 094c60dd4191a469b636ba98f905c9a917e5c64b @drobbins committed Feb 25, 2013
Showing with 30 additions and 1 deletion.
  1. +30 −1 readme.md
View
31 readme.md
@@ -1,4 +1,33 @@
Kanso-Backbone
--------------
-Backbone.js packaged as a [Kanso](http://kan.so) module. See the test branch for example usage.
+Backbone.js packaged as a [Kanso](http://kan.so) module. See the test branch for example usage.
+
+### Install
+
+Add `modules` to your dependencies section in `kanso.json`.
+
+```javascript
+...
+ "dependencies": {
+ "backbone": null,
+ ...
+ }
+```
+
+Run `kanso install` to fetch the package.
+
+
+### Usage
+
+```javascript
+(function($, Backbone) {
+ // backbone can use any DOM library you like
+ Backbone.setDomLibrary($);
+
+ // use Backbone like a boss
+ ...
+
+ // use require if you use the jquery kanso module
+ // or window.$ if you use the stock jQuery
+})(require('jquery'), require('backbone'));

0 comments on commit 094c60d

Please sign in to comment.