Skip to content

Commit

Permalink
docs: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Domino987 committed Jun 6, 2021
1 parent cf635b1 commit 3718162
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,54 @@
[Why does this repo exist?](https://material-table-core.com/docs/about) 🚧 [Documentation](https://material-table-core.com/docs) ⚙️ [Demos](https://material-table-core.com/demos)

</div>

# Quickstart

## Install material-table-core

### Yarn

`yarn add @material-table/core`

### NPM

`npm install @material-table/core`
&nbsp;
\
&nbsp;

## Change the import

```
- import MaterialTable from 'material-table';
+ import MaterialTable from '@material-table/core';
```

## And thats it. Enjoy.

&nbsp;
\
&nbsp;

# Material-ui V5

With `material-ui` becoming stable with a beta on July 1st and being promoted as the version to use, we starting to support both version v4 and v5.

If you migrated to version 5 of `material-ui`, simply install our prerelease version to access the new version that supports v5.

### Yarn

`yarn add @material-table/core@next`

### NPM

`npm install @material-table/core@next`
&nbsp;

### Breaking changes for v5

- `padding` now accepts 'normal' or 'dense'
- `onChangeRowsPerPage` => `onRowsPerPageChange`
- `onChangePage` => `onPageChange`

The version is still a work in progress and not fully tested.

0 comments on commit 3718162

Please sign in to comment.