This repository has been archived by the owner on Mar 7, 2023. It is now read-only.
chore: add deprecation notice to readme #169
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
README.md
Outdated
|
|
||
| This library is now deprecated. We recommend using [`usb`](https://github.com/node-usb/node-usb#migrating-from-node-usb-detection) for hotplug detection instead. It supports a wider range of platforms, using a more proven codebase. | ||
|
|
||
| For help migrating, refer to the [documentation for `usb`](https://github.com/node-usb/node-usb#migrating-from-node-usb-detection) |
There was a problem hiding this comment.
README.md
Outdated
| @@ -6,6 +6,13 @@ | |||
| `usb-detection` allows you to listen for insert/remove events of USB devices on your system. | |||
|
|
|||
|
|
|||
| ## Deprecated | |||
There was a problem hiding this comment.
I feel like this section is very easy to miss. Put it at the very top. Maybe some 🛑 emoji.
Any good examples to pull from?
There was a problem hiding this comment.
better?
I can't think of any good examples. Most things that I find are deprecated are marked as deprecated on npm and archived on github without much explanation
|
Thanks for updating this @Julusian! 🐆 I also updated the changelog, pushed a new npm version so the notice is visible, and deprecated the project. Will archive the GitHub project shortly ⏩ |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
As suggested in #127, I think it is time to think about deprecating this library.
https://github.com/node-usb/node-usb/releases/tag/v2.5.0 now supports native hotplug detection on a wider range of platforms, and will mitigate the very common issue users here have of node abi version mismatches, or missing prebuilds for new node/electron versions.