Skip to content

Commit 3ba2752

Browse files
committed
Update README
1 parent 201fb61 commit 3ba2752

1 file changed

Lines changed: 15 additions & 10 deletions

File tree

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# BlockUI - Page or element overlay
1+
# BlockUI - Page or element overlay [![NPM version][npm-image]][npm-url]
2+
3+
### NOTE: This is a fork from the official version, for publishing on npm. See https://github.com/malsup/blockui/pull/114
24

35
## Getting Started
46
Download either the [production version][min] or the [development version][max] of BlockUI.
@@ -8,21 +10,21 @@ Download either the [production version][min] or the [development version][max]
810

911
In your web page:
1012

11-
<pre>
12-
&lt;!-- include jQuery -->
13-
&lt;script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.js">&lt;/script>
14-
&lt;!-- include BlockUI -->
15-
&lt;script src="http://path/to/your/copy/of/jquery.blockUI.js">&lt;/script>
16-
&lt;script>
13+
```html
14+
<!-- include jQuery -->
15+
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.js"></script>
16+
<!-- include BlockUI -->
17+
<script src="http://path/to/your/copy/of/jquery.blockUI.js"></script>
18+
<script>
1719
// invoke blockUI as needed -->
1820
$(document).on('click', '#myButton', function() {
1921
$.blockUI();
2022
});
21-
>&lt;/script>
22-
</pre>
23+
</script>
24+
```
2325

2426
## Documentation, Demos and FAQ
25-
Everything you need to know can be found here:
27+
Everything you need to know can be found here:
2628
[http://jquery.malsup.com/block/](http://jquery.malsup.com/block/)
2729

2830

@@ -36,3 +38,6 @@ You may use either license. The MIT license is recommended for most projects be
3638
If the GPL suits your project better you are also free to use the plugin under that license.
3739

3840
You do not have to do anything special to choose one license or the other and you don't have to notify anyone which license you are using. You are free to use the BlockUI plugin in commercial projects as long as the copyright header is left intact.
41+
42+
[npm-url]: https://www.npmjs.com/package/block-ui/
43+
[npm-image]: http://img.shields.io/npm/v/block-ui.svg

0 commit comments

Comments
 (0)