Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Download readme on demand? #18

Open
FlorianWendelborn opened this issue Jan 11, 2017 · 3 comments
Open

Download readme on demand? #18

FlorianWendelborn opened this issue Jan 11, 2017 · 3 comments

Comments

@FlorianWendelborn
Copy link

Would be nice if I could get a package's README without having that package as a dependency in my current working directory.

@eush77
Copy link
Collaborator

eush77 commented Jan 12, 2017

You mean something like npm-man?

I am not sure if this should be integrated into readme. The nice thing about readme is that it reads the same versions of packages that are used by your app. If we reach Npm or GitHub or some other source for readmes this will not be the case.

Do you have a strong feeling about this?

@FlorianWendelborn
Copy link
Author

I'm not suggesting to change the default behavior. I'm suggesting this as a fallback, when no readme was found.

If I'm not mistaken most node devs actually use the most recent (or a really recent) package version, so it doesn't even make a difference in most cases.

I actually really prefer the readme style compared to npm-man, so this would be a welcome addition, even though npm-man seems to do something similar.

My main reason to do it like this is that I don't always work in the same directory the package is installed in. I'm working on multiple micro-services at the same time and they don't always have the same codebase/dependencies.

@hackergrrl
Copy link
Contributor

Just wrote #19 before reading this. I think this is a reasonable feature to add. Maybe offer a -N switch for "no network" which can fast-fail, or the reverse: require a switch like -n to indicate a desire for a network download of the readme.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants