Skip to content

Commit dab02a5

Browse files
committed
README.markdown: use more Markdown syntax.
use the relative link to LICENSE.txt and break a very long line.
1 parent 99173ec commit dab02a5

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.markdown

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,28 @@
22

33
A jQuery plugin that adds cross-browser mouse wheel support.
44

5-
In order to use the plugin, simply bind the "mousewheel" event to an element. It also provides two helper methods called `mousewheel` and `unmousewheel` that act just like other event helper methods in jQuery. The event callback receives three extra arguments which are the normalized "deltas" of the mouse wheel.
5+
In order to use the plugin, simply bind the `mousewheel` event to an element.
6+
It also provides two helper methods called `mousewheel` and `unmousewheel`
7+
that act just like other event helper methods in jQuery. The event callback
8+
receives three extra arguments which are the normalized "deltas" of the mouse wheel.
69

710
Here is an example of using both the bind and helper method syntax.
811

9-
// using bind
10-
$('#my_elem').bind('mousewheel', function(event, delta, deltaX, deltaY) {
11-
console.log(delta, deltaX, deltaY);
12-
});
12+
```js
13+
// using bind
14+
$('#my_elem').bind('mousewheel', function(event, delta, deltaX, deltaY) {
15+
console.log(delta, deltaX, deltaY);
16+
});
1317

14-
// using the event helper
15-
$('#my_elem').mousewheel(function(event, delta, deltaX, deltaY) {
16-
console.log(delta, deltaX, deltaY);
17-
});
18+
// using the event helper
19+
$('#my_elem').mousewheel(function(event, delta, deltaX, deltaY) {
20+
console.log(delta, deltaX, deltaY);
21+
});
22+
```
1823

1924

2025
## License
2126

22-
This plugin is licensed under the MIT License (LICENSE.txt).
27+
This plugin is licensed under the [MIT License](LICENSE.txt).
2328

2429
Copyright (c) 2013 [Brandon Aaron](http://brandonaaron.net)

0 commit comments

Comments
 (0)