Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

proposed Module rename. -api => -http-client #892

Closed
daviddias opened this issue Nov 15, 2018 · 6 comments · Fixed by #897
Closed

proposed Module rename. -api => -http-client #892

daviddias opened this issue Nov 15, 2018 · 6 comments · Fixed by #897
Assignees

Comments

@daviddias
Copy link
Contributor

Hi! We are considering renaming the IPFS Client libraries, please read more at ipfs/ipfs#374 and comment if you are onboard.

@achingbrain
Copy link
Collaborator

-client makes me think of client/server, which this sort of is, but then people start thinking about HTTP and talking about 'uploading things to IPFS' which derails conversations when you're trying to talk about distributed systems.

Not wanting to bike shed but -remote might be better (or not, whatevs) but you're right -api sounds like something this is not.

@daviddias daviddias changed the title proposed Module rename. -api => -client proposed Module rename. -api => -http-client Nov 17, 2018
@daviddias
Copy link
Contributor Author

We are going to move with js-ipfs-http-client for the next name. @alanshaw please consider this for the next release.

@alanshaw
Copy link
Contributor

⚡️ 👍

@richardschneider
Copy link
Contributor

So by module rename, do you mean renaming the GitHub repo. Currently I have https://github.com/richardschneider/net-ipfs-api and should that now be net-ipfs-http-client?

Renaming a repo will break all links to the repo and most likely upset any existing forks. Also how does this effect the package managers and existing software dependent upon the old name?

Any recommended practices on how to go about this?

@daviddias
Copy link
Contributor Author

Renaming a repo will break all links to the repo and most likely upset any existing forks.

Github is pretty good at redirecting the old name to the new one

Also how does this effect the package managers and existing software dependent upon the old name?

It is a two step. One deprecates first the old module name and then publishes with the new one.

@alanshaw
Copy link
Contributor

One deprecates first the old module name

FYI https://docs.npmjs.com/cli/deprecate

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 a pull request may close this issue.

4 participants