Updated misleading documentation for 3.x version - Githubissues

chimurai / http-proxy-middleware

:zap: The one-liner node.js http-proxy middleware for connect, express, next.js and more

MIT License

10.68k stars 826 forks source link

Updated misleading documentation for 3.x version #849

Closed ggondim closed 1 year ago

ggondim commented 1 year ago

Description

Updates misleading documentation about the latest version (3.0.0-beta.0):

Added new npm badge clarifying the difference between default npm version (stable v2) and beta version (v2)
Updated "Install" section to include the full version of 3.0.0-beta.0

Motivation and Context

The default version installed from npm is still the v2 because v3 is suffixed with a prerelease version ("beta").

This causes a misleading installation when developers just run npm install http-proxy-middleware.

Types of changes

[x] Documentation fix (non-breaking change which clarifies documentation)

Checklist:

[x] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.

chimurai commented 1 year ago

Thanks for the suggestion!

Fixed in https://github.com/chimurai/http-proxy-middleware/pull/894

Changed (stable and latest) to (latest and beta); conforming to npm tags