Improve readme

[gucki]

It should probably pointed out in the readme that you cannot bind on the shown and hidden event directly on the modal but one must use modal.$el instead:

Does not work

modal.on('shown', function() {
  // some code
});

Works

modal.$el.on('shown', function() {
  // some code
});

[powmedia]

The events are proxied through the modal so it should work. However there is another bug (#4) related to pressing Esc to close the modal which doesn't trigger this, which may be where you're running into the problem.

[gucki]

I tried using it without the $el and it does not work for me. Probably the proxy is broken?

Failing code:

view = new MyApp.Views.SomeEdit(model: @model)
modal = new Backbone.BootstrapModal(content: view)
modal.on 'shown', -> alert('test')
modal.on 'ok', => modal.preventClose() unless view.save()
modal.open()

Working code:

view = new MyApp.Views.SomeEdit(model: @model)
modal = new Backbone.BootstrapModal(content: view)
modal.$el.on 'shown', -> alert('test')
modal.on 'ok', => modal.preventClose() unless view.save()
modal.open()