Updates README.md for css-loader versions below 3

unematiii · Oct 7, 2020 · 929c0a7 · 929c0a7
1 parent e432822
commit 929c0a7
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -34,6 +34,24 @@ const getLocalIdent = getLocalIdentName();
 },
 ```
 
+For `css-loader` versions below `3.*`, `modules` options should be specified in loader `options` block instead:
+
+```js
+const { getLocalIdentName } = require('css-loader-shorter-classnames');
+
+const getLocalIdent = getLocalIdentName();
+
+// Loader options
+{
+  // ...
+  loader: 'css-loader',
+  options: {
+    modules: true,
+    getLocalIdent: getLocalIdent,
+  },
+},
+```
+
 ## Enable only for production
 ```js
 const { getLocalIdentName } = require('css-loader-shorter-classnames');

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "css-loader-shorter-classnames",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Provides short class name generator for css-loader with CSS Modules enabled",
   "main": "index.js",
   "files": [