README file should explain what the software is

[ebiggers]

README files conventionally begin with a brief description of what the software is. There is no such description in the README file for nvm, which is unfriendly for beginners.

[ljharb]

The tagline at the top says "Simple bash script to manage multiple active node.js versions", and is the first place beginners should be looking when looking at a repo - do you think repeating that in the README will add much value?

[ebiggers]

The text you're quoting isn't present in the repository itself, only in the Github UI. Not everyone will view the Github UI before they clone the repository. In addition, some people may install software and its documentation via a package manager. Providing a brief overview of a software package in its README file (if one is provided) is a decades old convention. If you don't think this is important feel free to close this issue as I don't have time to argue; I just thought I would point out a usability issue.

[ljharb]

nvm must not be installed via a package manager - it is entirely unsupported unless installed via the curl command in the readme - and I'd be very surprised if someone cloned the repo without ever visiting the Github UI.

That said, thanks for the feedback, and I'd love a PR that added more helpful text!

[Theodeus]

I just spent half an hour trying to figure out why my nvm install didn't work. Didn't realize nvm is a .sh, and I did "which nvm" to check if it was present on my system. Maybe the README could have a "how to verify install" step for goofballs like me?

EDIT: opening separate issue, sorry to hijack!

[naomiquinones]

Hi @ljharb, the README now has an "About" section that describes what nvm does, albeit not in the same way as the commit in the fork mentioned above. Does that text still seem relevant (and therefore could be incorporated into the current README), would different additional wording clarify it more, or should this issue be closed?

[ljharb]

hmm, fair point. #1040 is still open, and seems to have just slipped through the cracks. I'll take another look at it; if it seems landable with trivial tweaks, i'll do so; if not, i'll close this issue and the PR.