Skip to content

Commit b3f3803

Browse files
authored
docs: add replacements to readme (#39)
1 parent d23b3a4 commit b3f3803

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This action compares dependencies between your base branch and current branch, a
1010
- 📈 **Dependency growth** - Warns when dependency count increases significantly
1111
- 📦 **Install size** - Warns when package size increases significantly
1212
- 🔄 **Duplicate versions** - Detects packages with multiple versions installed
13+
- ⚠️ **Module replacements** - Identifies new packages that have community-recommended alternatives
1314

1415
## Usage
1516

@@ -83,6 +84,19 @@ The action accepts glob patterns to locate package tarballs for comparison:
8384

8485
You can see an example of how to set this up in the [bundle difference workflow](./recipes/bundle-diff.yml).
8586

87+
## Module Replacements
88+
89+
This action automatically scans for new dependencies that have community-recommended replacements or alternatives.
90+
91+
The recommendations come from the [e18e community](https://e18e.dev) and include manifests for:
92+
93+
- Native alternatives
94+
- Micro-utility alternatives
95+
- Generally preferred packages
96+
97+
> [!NOTE]
98+
> Module replacement suggestions are advisory and may not always be straightforward migrations. Review each recommendation carefully and use exclusion features if needed.
99+
86100
## Supported package managers
87101

88102
- npm (package-lock.json)

0 commit comments

Comments
 (0)