Skip to content

Commit 7ff3510

Browse files
committed
Update readme for clearer install instructions
1 parent 91e9084 commit 7ff3510

1 file changed

Lines changed: 11 additions & 16 deletions

File tree

Readme.md

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

3-
This package contains a built distribution of the [StateRestore extension](https://datatables.net/extensions/staterestore) for [DataTables](https://datatables.net/) with styling for [jQueryUI](http://jqueryui.com/).
3+
This is the distribution package for the [StateRestore extension](https://datatables.net/extensions/staterestore) for [DataTables](https://datatables.net/) with styling for [jQueryUI](http://jqueryui.com/).
44

55
The StateRestore extension for DataTables builds on the `stateSave` option within DataTable's core. This allows users to save multiple different states and reload them at any time, not just at initialisation.
66

@@ -9,43 +9,38 @@ The StateRestore extension for DataTables builds on the `stateSave` option withi
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
```
19+
npm install datatables.net-jqui
1720
npm install datatables.net-staterestore-jqui
1821
```
1922

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

26-
ES6 Syntax
2725
```
26+
import DataTable from 'datatables.net-jqui';
2827
import 'datatables.net-staterestore-jqui'
29-
```
3028
31-
### bower
32-
33-
```
34-
bower install --save datatables.net-staterestore-jqui
29+
new DataTable('#myTable', {
30+
// initalisation options
31+
});
3532
```
3633

3734

38-
3935
## Documentation
4036

41-
Full documentation and examples for StateRestore can be found [on the website](https://datatables.net/extensions/staterestore).
37+
Full documentation and examples for StateRestore can be found [on the DataTables website](https://datatables.net/extensions/staterestore).
4238

4339

4440
## Bug / Support
4541

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

48-
4944
### Contributing
5045

5146
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/StateRestore](http://github.com/DataTables/StateRestore). For issues / bugs, please direct your questions to the [DataTables forums](//datatables.net/forums).

0 commit comments

Comments
 (0)