Docs update

Author: Septh

README.md

@@ -3,28 +3,16 @@ A Rollup plugin that automatically declares NodeJS built-in modules as `external
 
 Works in monorepos too!
 
-> ### Breaking changes in version 5
-> - In previous versions, the `devDeps` option (see below) defaulted to `true`.<br>This was practical, but often wrong: devDependencies are meant just for that: being used when developping. Therefore, the `devDeps` option now defaults to `false`, meaning Rollup will include them in your bundle.
->- As anticipated since v4, the `builtinsPrefix` option now defaults to `'add'`.
->- The deprecated `prefixedBuiltins` option has been removed.
-> - `rollup-plugin-node-externals` no longer depends on the Find-Up package (while this is not a breaking change per se, it can be in some edge situations).
-> - Now has a _peer dependency_ on `rollup ^2.60.0 || ^3.0.0`.
-
-> ### Breaking changes in version 4
-> - In previous versions, the `deps` option (see below) defaulted to `false`.<br>This was practical, but often wrong: when bundling for distribution, you want your own dependencies to be installed by the package manager alongside your package, so they should not be bundled in the code. Therefore, the `deps` option now defaults to `true`.
-> - Now requires Node 14 (up from Node 12 for previous versions).
-> - Now has a _peer dependency_ on `rollup ^2.60.0`.
-
 ## Why you need this
 <details><summary>(click to expand)</summary>
 
-By default, Rollup doesn't know a thing about NodeJS, so trying to bundle simple things like `import path from 'path'` in your code generates an `Unresolved dependencies` warning.
+By default, Rollup doesn't know a thing about NodeJS, so trying to bundle simple things like `import path from 'node:path'` in your code generates an `Unresolved dependencies` warning.
 
-The solution here is quite simple: you must tell Rollup that the `path` module is in fact `external`. This way, Rollup won't try to bundle it in and rather leave the `import` statement as is (or translate it to a `require()` call if bundling for CommonJS).
+The solution here is quite simple: you must tell Rollup that the `node:path` module is in fact _external_. This way, Rollup won't try to bundle it in and rather leave the `import` statement as is (or translate it to a `require()` call if bundling for CommonJS).
 
-However, this must be done for each and every NodeJS built-in you happen to use in your program: `path`, `os`, `fs`, `url`, etc., which can quicky become cumbersome when done manually.
+However, this must be done for each and every NodeJS built-in you happen to use in your program: `node:path`, `node:os`, `node:fs`, `node:url`, etc., which can quicky become cumbersome when done manually.
 
-So the primary goal of this plugin is simply to automatically declare all NodeJS built-in modules as `external`.
+So the primary goal of this plugin is simply to automatically declare all NodeJS built-in modules as external.
 
 As an added bonus, this plugin will also allow you to declare your dependencies (as per your local or monorepo `package.json` file(s)) as external.
 </details>
@@ -38,7 +26,7 @@ npm install --save-dev rollup-plugin-node-externals
 ## Usage
 When bundling an application or library, you want to have your **runtime dependencies** listed under `dependencies` in `package.json`, and **development dependencies** listed under `devDependencies`.
 
-If you follow this simple rule, then the built-in defaults are just what you need:
+If you follow this simple rule, then the defaults are just what you need:
 ```js
 export default {
   ...
@@ -48,17 +36,7 @@ export default {
 }
 ```
 
-- Or, if you'd rather bundle dependencies in:
-```js
-export default {
-  ...
-  plugins: [
-    externals({
-      deps: false,    // Dependencies will be bundled in
-    }),
-  ]
-}
-```
+This will bundle your `devDependencies` in while leaving your `dependencies`, `peerDependencies` and `optionalDependencies` external.
 
 ### Options
 All options are, well, optional.
@@ -122,15 +100,15 @@ Set the `deps`, `devDeps`, `peerDeps` and `optDeps` options to `false` to preven
 
 #### include?: string | RegExp | (string | RegExp)[] = []
 #### exclude?: string | RegExp | (string | RegExp)[] = []
-Use the `include` option to force certain dependencies into the list of externals:
+Use the `include` option to force certain dependencies into the list of externals, regardless of other settings:
 ```js
 externals({
   deps: false,                // Deps will be bundled in
   include: /^fsevents/        // Except for fsevents
 })
 ```
 
-Conversely, use the `exclude` option to remove certain dependencies from the list of externals:
+Conversely, use the `exclude` option to remove certain dependencies from the list of externals, regardless of other settings:
 ```js
 externals({
   deps: true,                 // Deps are external
@@ -144,11 +122,14 @@ Falsy values in `include` and `exclude` are silently ignored. This allows for co
 
 ### 2/ This plugin is not _that_ smart
 It uses an exact match against your imports, so if your are using some kind of path substitution in your code, eg.:
+
 ```js
 // In your code, say '@/' is mapped to some directory:
 import something from '@/mylib'
 ```
+
 and you don't want `mylib` bundled in, then write:
+
 ```js
 // In rollup.config.js:
 externals({
@@ -160,7 +141,8 @@ However, subpath imports are supported with regexes, meaning that `include: /^lo
 
 
 ### 3/ Order matters
-If you're also using `@rollup/plugin-node-resolve`, make sure this plugin comes _before_ it in the `plugins` array:
+If you're also using [`@rollup/plugin-node-resolve`](https://github.com/rollup/plugins/tree/master/packages/node-resolve/#readme), make sure this plugin comes _before_ it in the `plugins` array:
+
 ```js
 import externals from 'rollup-plugin-node-externals'
 import resolve from '@rollup/plugin-node-resolve'
@@ -173,11 +155,29 @@ export default {
   ]
 }
 ```
+
 As a general rule of thumb, you might want to always make this plugin the first one in the `plugins` array.
 
 ### 4/ Rollup rules
 Rollup's own `external` configuration option always takes precedence over this plugin. This is intentional.
 
 
+## Breaking changes
+<details><summary>(click to expand)</summary>
+
+### Breaking changes in version 5
+- In previous versions, the `devDeps` option (see below) defaulted to `true`.<br>This was practical, but often wrong: devDependencies are meant just for that: being used when developping. Therefore, the `devDeps` option now defaults to `false`, meaning Rollup will include them in your bundle.
+- As anticipated since v4, the `builtinsPrefix` option now defaults to `'add'`.
+- The deprecated `prefixedBuiltins` option has been removed.
+- `rollup-plugin-node-externals` no longer depends on the Find-Up package (while this is not a breaking change per se, it can be in some edge situations).
+- Now has a _peer dependency_ on `rollup ^2.60.0 || ^3.0.0`.
+
+### Breaking changes in version 4
+- In previous versions, the `deps` option (see below) defaulted to `false`.<br>This was practical, but often wrong: when bundling for distribution, you want your own dependencies to be installed by the package manager alongside your package, so they should not be bundled in the code. Therefore, the `deps` option now defaults to `true`.
+- Now requires Node 14 (up from Node 12 for previous versions).
+- Now has a _peer dependency_ on `rollup ^2.60.0`.
+</summary>
+
+
 ## Licence
 MIT