Skip to content
This repository has been archived by the owner on Feb 26, 2021. It is now read-only.

chore: add deprecation notice #81

Merged
merged 2 commits into from
Jun 10, 2020
Merged

Conversation

vasco-santos
Copy link
Member

@vasco-santos vasco-santos commented Jun 10, 2020

In the context of the async refactor in [email protected], this modules is being deprecated.
For immediate alternatives, you should use libp2p/js-libp2p-webrtc-star. Meanwhile, you should follow libp2p/js-libp2p#385, as I am currently working on this vertical.

Needs:

  • npm deprecation notice

After merged, the repo must be archived

@vasco-santos vasco-santos requested a review from jacobheun June 10, 2020 09:05
@jacobheun
Copy link
Contributor

I think we should wait to archive the repo. The notices are fine, but as there are people still using this quite a bit, we should allow some more time to upgrade before archiving in case any patches are needed.

@vasco-santos
Copy link
Member Author

I agree! That's why I also did not merge libp2p-keychain and peer-info...
How should we proceed? I suggest that we merge the PRs and do the deprecation notices and we define a date for archiving and create an issue to track that.

@jacobheun
Copy link
Contributor

I suggest that we merge the PRs and do the deprecation notices and we define a date for archiving and create an issue to track that.

sgtm, we can discuss timeline in the issue.

Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but in my experience people often skip stuff when scanning READMEs.
I tweaked deprecation notice to be more prominent (based on this) – hope thats okay :)

btw: someone with admin rights should also update description, example:

2020-06-10--19-14-33

@jacobheun jacobheun merged commit 664dc05 into master Jun 10, 2020
@jacobheun jacobheun deleted the chore/add-deprecation-notice branch June 10, 2020 17:20
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants