Merge pull request #1 from salesforce/kevinv11n-patch-1

Update README.md

Author: pmdartus

README.md

@@ -45,7 +45,7 @@ Prevent common Javascript pitfalls and enforces all best practices.
 ### `@salesforce/eslint-config-lwc/extended` configuration
 
 **Goal:**
-Restrict usage of some Javascript language features known to be slow after the _COMPAT_ transformation. LWC runs in _COMPAT_ mode on older browsers (eg. IE11). In order to support new javascript syntax and language features on those browser, the LWC compiler need to do some transformations to the LWC module. Some of those transformations are known to be slow, this linting config targets certain patterns that are known to be expensive at runtime.
+Restrict usage of some Javascript language features known to be slow after the _COMPAT_ transformation. LWC runs in _COMPAT_ mode on older browsers (eg. IE11). To support new Javascript syntax and language features on older browser the LWC compiler transforms LWC modules. This linting configuraton targets patterns known to be slow in _COMPAT_ mode..
 
 **Rules:**
 `@salesforce/eslint-config-lwc/recommended` rules + restrict usage of some slow patterns in _COMPAT_.

lib/defaults.js

@@ -1,14 +1,8 @@
 'use strict';
 
 /**
- * Base configuration for all the shared configuration. This file is intentionally not located at the root of the
- * package like the other configuration to about being consumed like the other shareable config via:
- *
- * ```
- * {
- *     "extends": "@salesforce/eslint-config-lwc/default"
- * }
- * ```
+ * Internal base configuration for all the shared configuration. This file is intentionally not located at the root of
+ * the package to avoid being exported and exposed.
  */
 module.exports = {
     parser: 'babel-eslint',