Skip to content
This repository has been archived by the owner on Oct 18, 2018. It is now read-only.

Commit

Permalink
Readme polish.
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Staubo committed Jul 26, 2011
1 parent dbe7c8c commit e5b8955
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
@@ -1,14 +1,19 @@
Collection view for Backbone and JQuery
=======================================

`Backbone.JQuery.CollectionView` is a generic, reusable view implementation which provides automatic creation of item views, as well as rudimentary reordering using mouse dragging, similar to JQuery's `Sortable`. Currently only vertical dragging is supported.
This library provides a generic, reusable view which provides:

* Automatic management of item views
* Reordering using mouse dragging

Currently only vertical dragging is supported. Future plans include horizontal and hierarchical dragging and HTML5 drag/drop.

Usage
-----

There are some examples in the `examples` directory. Basically:

* Subclass the collection view and override the `createSubview()` method to return a view that corresponds to each model in the collection.
* Subclass `Backbone.JQuery.CollectionView` and override the `createSubview()` method to return a view that corresponds to each model in the collection.
* Instantiate the collection view with a hash of options.
* Call `render()` on the view.

Expand Down

0 comments on commit e5b8955

Please sign in to comment.