From e789cfd6a8a8838e5878149fdc5bea6e2ded6984 Mon Sep 17 00:00:00 2001 From: Maik Marschner Date: Tue, 28 May 2019 21:05:35 +0200 Subject: [PATCH] Add a note on the different versions. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 5803506..a1b6f92 100644 --- a/README.md +++ b/README.md @@ -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.