Skip to content

Commit

Permalink
Add a note on the different versions.
Browse files Browse the repository at this point in the history
  • Loading branch information
leMaik committed May 28, 2019
1 parent ba90ad7 commit e789cfd
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ is exported.
npm install mdi-material-ui --save
```

There are three major versions of this package, each one for different Material-UI releases. All three versions will receive icon updates as minor releases for the foreseeable future.

| Material-UI | mdi-material-ui |
|---|---|
|0.x|^4.0.0|
|^1.0.0, ^3.0.0|^5.0.0|
|^4.0.0|^6.0.0|

## Usage
Every icon is exported with its original name in PascalCase. So `coffee` becomes `Coffee`,
`cloud-print-outline` is exported as `CloudPrintOutline` and so on.
Expand Down

0 comments on commit e789cfd

Please sign in to comment.