feat(docs): publish updated readme #244
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
jennifer-shehane
approved these changes
Oct 30, 2024
|
🎉 This PR is included in version 4.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
The
Readmetab on the npm registry https://www.npmjs.com/package/eslint-plugin-cypress is outdated compared to the README.md document in themasterbranch of the repository.Changes from PR #239, which swapped the flat and legacy documentation locations, are missing. Some other minor documentation updates are also unpublished to the npm registry. Clicking on links in the
Readmepulls up the repo contents and can lead to a slightly confusing reading experience.The npm registry displays the
Readmefrom released versions, and by default from thelatestversion. It does not display the README.md from themasterbranch of the repository.Change
This PR is an empty commit with a commit message to trigger a new release intended to publish the README.md from the repository to the npm registry https://www.npmjs.com/package/eslint-plugin-cypress.