find-esm-packages - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

package.json

 {
   "name": "find-esm-packages",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Find packages with 'module' in their package.json",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # find-esm-packages
+
+Find libraries in your package.json file that have the 'module' attribute. This signifies that the library contains an esm directory that could be resolved to, thus improving tree shaking abilities. This is great to use if you're using webpack or rollup.
+
+### Usage
+
+```javascript
+const findEsmPackages = require('find-esm-packages');
+
+findEsmPackages();
+```
+
+
+### Options
+#### dirname
+Directory path
+
+#### checks
+Array of the dependencies to check. E.g. ['dependencies', 'devDependencies']
+
+#### paths
+Will return the `main` and `module` values.
+
+```javascript
+[
+  {
+    name: 'foo',
+    main: 'foo/lib/index.js',
+    module: 'foo/esm/index.esm.js',
+  },
+]
+```

No alert changes

Improved metrics

Total package byte prevSize

3412

increased by24.12%

Number of lines in readme file

33

increased by1550%

No dependency changes