Skip to content

Commit

Permalink
Update readme for clearer install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
AllanJard committed Jan 22, 2025
1 parent 1dbe995 commit 31c40af
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# StateRestore for DataTables with styling for [SemanticUI](https://semantic-ui.com/)

This package contains a built distribution of the [StateRestore extension](https://datatables.net/extensions/staterestore) for [DataTables](https://datatables.net/) with styling for [SemanticUI](https://semantic-ui.com/).
This is the distribution package for the [StateRestore extension](https://datatables.net/extensions/staterestore) for [DataTables](https://datatables.net/) with styling for [SemanticUI](https://semantic-ui.com/).

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.

Expand All @@ -9,43 +9,38 @@ The StateRestore extension for DataTables builds on the `stateSave` option withi

### Browser

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.
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.

### npm

For installation via npm, yarn and other similar package managers, install this package with your package manager - e.g.:

```
npm install datatables.net-se
npm install datatables.net-staterestore-se
```

ES3 Syntax
```
var $ = require( 'jquery' );
var dt = require( 'datatables.net-staterestore-se' )( window, $ );
```
Then, to load and initialise the software in your code use:

ES6 Syntax
```
import DataTable from 'datatables.net-se';
import 'datatables.net-staterestore-se'
```
### bower

```
bower install --save datatables.net-staterestore-se
new DataTable('#myTable', {
// initalisation options
});
```



## Documentation

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


## Bug / Support

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


### Contributing

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).
Expand Down

0 comments on commit 31c40af

Please sign in to comment.