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 07eeaee commit 7daa9c5
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DataTables for jQuery with styling for [DataTables](https://datatables.net/)
# DataTables with [DataTables](https://datatables.net/) styling

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

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.

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

### 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-dt
```

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

ES6 Syntax
```
import 'datatables.net-dt'
import DataTable from 'datatables.net-dt';
new DataTable('#myTable', {
// initalisation options
});
```

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

```
bower install --save datatables.net-dt
```
const DataTable = require('datatables.net-dt');
new DataTable('#myTable', {
// initalisation options
});
```


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

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

0 comments on commit 7daa9c5

Please sign in to comment.