Skip to content

Commit 0c76a04

Browse files
committed
Update readme for clearer install instructions
1 parent 10a8a0d commit 0c76a04

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

Readme.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# DataTables for jQuery with styling for [jQueryUI](http://jqueryui.com/)
1+
# DataTables with [jQueryUI](http://jqueryui.com/) styling
22

3-
This package contains distribution files required to style [DataTables library](https://datatables.net) for [jQuery](http://jquery.com/) with styling for [jQueryUI](http://jqueryui.com/).
3+
This package contains distribution files required to style [DataTables table enhancement library](https://datatables.net) with styling integration for [jQueryUI](http://jqueryui.com/).
44

55
DataTables is a table enhancing library which adds features such as paging, ordering, search, scrolling and many more to a static HTML page. A comprehensive API is also available that can be used to manipulate the table. Please refer to the [DataTables web-site](//datatables.net) for a full range of documentation and examples.
66

@@ -9,31 +9,35 @@ DataTables is a table enhancing library which adds features such as paging, orde
99

1010
### Browser
1111

12-
For inclusion of this library using a standard `<script>` tag, rather than using this package, it is recommended that you use the [DataTables download builder](//datatables.net/download) which can create CDN or locally hosted packages for you, will all dependencies satisfied.
12+
To use DataTables with a simple `<script>` tag, rather than using this package, it is recommended that you use the [DataTables download builder](//datatables.net/download) which can create CDN or locally hosted packages for you, will all dependencies satisfied.
1313

1414
### npm
1515

16+
For installation via npm, yarn and other similar package managers, install this package with your package manager - e.g.:
17+
1618
```
1719
npm install datatables.net-jqui
1820
```
1921

20-
ES3 Syntax
21-
```
22-
var $ = require( 'jquery' );
23-
require( 'datatables.net-jqui' )( window, $ );
24-
```
22+
Then, to load and initialise DataTables in your code use:
2523

26-
ES6 Syntax
2724
```
28-
import 'datatables.net-jqui'
25+
import DataTable from 'datatables.net-jqui';
26+
27+
new DataTable('#myTable', {
28+
// initalisation options
29+
});
2930
```
3031

31-
### bower
32+
If you are using an old version of Node or a CommonJS loader, you might need to use the `require` syntax:
3233

3334
```
34-
bower install --save datatables.net-jqui
35-
```
35+
const DataTable = require('datatables.net-jqui');
3636
37+
new DataTable('#myTable', {
38+
// initalisation options
39+
});
40+
```
3741

3842

3943
## Documentation
@@ -45,7 +49,6 @@ Full documentation of the DataTables options, API and plug-in interface are avai
4549

4650
Support for DataTables is available through the [DataTables forums](//datatables.net/forums) and [commercial support options](//datatables.net/support) are available.
4751

48-
4952
### Contributing
5053

5154
If you are thinking of contributing code to DataTables, first of all, thank you! All fixes, patches and enhancements to DataTables are very warmly welcomed. This repository is a distribution repo, so patches and issues sent to this repo will not be accepted. Instead, please direct pull requests to the [DataTables/DataTablesSrc](http://github.com/DataTables/DataTablesSrc). For issues / bugs, please direct your questions to the [DataTables forums](//datatables.net/forums).

0 commit comments

Comments
 (0)