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 aa9fd6a commit 094bcce
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 @@
# Responsive for DataTables with styling for [Bootstrap5](https://getbootstrap.com/)

This package contains a built distribution of the [Responsive extension](https://datatables.net/extensions/responsive) for [DataTables](https://datatables.net/) with styling for [Bootstrap5](https://getbootstrap.com/).
This is the distribution package for the [Responsive extension](https://datatables.net/extensions/responsive) for [DataTables](https://datatables.net/) with styling for [Bootstrap5](https://getbootstrap.com/).

In the modern world of responsive web design tables can often cause a particular problem for designers due to their row based layout. Responsive is an extension for DataTables that resolves that problem by optimising the table's layout for different screen sizes through the dynamic insertion and removal of columns from the table.

Expand All @@ -9,43 +9,38 @@ In the modern world of responsive web design tables can often cause a particular

### 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-bs5
npm install datatables.net-responsive-bs5
```

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

ES6 Syntax
```
import DataTable from 'datatables.net-bs5';
import 'datatables.net-responsive-bs5'
```
### bower

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



## Documentation

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


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

0 comments on commit 094bcce

Please sign in to comment.