Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated misleading documentation for 3.x version #849

Closed
wants to merge 1 commit into from

Conversation

ggondim
Copy link

@ggondim ggondim commented Nov 14, 2022

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) npm
    npm
  • Updated "Install" section to include the full version of 3.0.0-beta.0
    image

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.

image

Types of changes

  • Documentation fix (non-breaking change which clarifies documentation)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@chimurai
Copy link
Owner

chimurai commented Mar 7, 2023

Thanks for the suggestion!

Fixed in #894

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants