Skip to content
This repository has been archived by the owner on Nov 9, 2017. It is now read-only.

Update readme formatting #21

Merged
merged 1 commit into from
Feb 1, 2013
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ JavaScript manifest file:

And it just works!

## `$.setReadyEvent`
## Customization

### $.setReadyEvent

By default [ready](https://github.com/kossnocorp/jquery.turbolinks/blob/master/src/jquery.turbolinks.coffee#L17:L18) function is bound to [page:load](https://github.com/rails/turbolinks/#events) event.

Expand All @@ -34,7 +36,7 @@ If you want to change it use `$.setReadyEvent` function:
$.setReadyEvent('page:change');
```

## `$.setFetchEvent`
### $.setFetchEvent

By default right after trigger `page:fetch` `$.isReady` is set to false. And after `page:load` is set to true.

Expand All @@ -44,41 +46,43 @@ If you want to change default behaviour you can use `$.setFetchEvent`:
$.setReadyEvent('custom_loading_event');
```

# Changelog
## Changelog

This project uses [Semantic Versioning](http://semver.org/) for release numbering.

## 1.0.0-rc2 (January 31, 2013)
### 1.0.0-rc2 (January 31, 2013)

* Fix problem with 3rd-party libraries [#12](https://github.com/kossnocorp/jquery.turbolinks/issues/12), [#15](https://github.com/kossnocorp/jquery.turbolinks/issues/15)
* Reopen [#8](https://github.com/kossnocorp/jquery.turbolinks/issues/8)

## 1.0.0-rc1 (November 28, 2012)
### 1.0.0-rc1 (November 28, 2012)

* Set $.isReady to false after `page:fetch` [#6](https://github.com/kossnocorp/jquery.turbolinks/issues/6);
* add `$.setFetchEvent` function;
* remove all delegated events after trigger fetch event [#8](https://github.com/kossnocorp/jquery.turbolinks/issues/8).

## 1.0.0-rc (November 8, 2012)
### 1.0.0-rc (November 8, 2012)

* Add turbolinks as dependency (kudos to [@gbchaosmaster](https://github.com/gbchaosmaster));
* run callback after adding to waiting list if `$.isReady` [#6](https://github.com/kossnocorp/jquery.turbolinks/issues/6).

## 0.2.1 (October 15, 2012)
### 0.2.1 (October 15, 2012)

* Pass jQuery object to each callback [#4](https://github.com/kossnocorp/jquery.turbolinks/issues/4)

## 0.2.0 (October 10, 2012)
### 0.2.0 (October 10, 2012)

* Change event: `page:change` -> `page:load` (kudos to [@davydotcom](https://github.com/davydotcom));
* added ability to change ready event via `$.setReadyEvent`

## 0.1.0 (October 3, 2012)
### 0.1.0 (October 3, 2012)

* First, initial release

# Contributors
## Contributors

Idea and code by [@kossnocorp](http://koss.nocorp.me/).

# [The MIT License](https://github.com/kossnocorp/jquery.turbolinks/blob/master/LICENSE.md)
## License

[The MIT License](https://github.com/kossnocorp/jquery.turbolinks/blob/master/LICENSE.md)