Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
EvandroLG committed Oct 5, 2016
1 parent e831592 commit a6f3153
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,15 @@ Then you need to call the `pageAccelerator` function, such as the example bellow
pageAccelerator();
```

`pageAccelerator` can also receive a callback as a parameter - this callback will be called whenever a new page has loaded.

Just call it and pageAccelerator was already following the web application links.

For links that you don't want to be followed, you need simply add `data-pageAccelerator="false"`.

## Parameters
`pageAccelerator` can also receive an object as a parameter with the following options:
* **beforeLoading** <code>function</code>: Will be called whenever a new page was requested by a click or the browser back
* **afterLoading** <code>function</code>: Will be called whenever a new page has been loaded

## Team
pageAccelerator was made with love by a bunch of [awesome contributors](https://github.com/EasyFood/pageAccelerator/graphs/contributors).

Expand Down

0 comments on commit a6f3153

Please sign in to comment.