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

updated documentation based on the discussion in #134 #139

Merged
merged 1 commit into from Jan 16, 2016
Merged

Conversation

bcoe
Copy link
Member

@bcoe bcoe commented Jan 15, 2016

I've updated documentation based on the discussion in #134. @jamestalmage, @tcurdt, could you give this a read?

fixes #134

@tcurdt
Copy link

tcurdt commented Jan 15, 2016

Does help - but still a bit vague on whether referring to the binary needs a ./node_modules/.bin prefix or not.

@bcoe
Copy link
Member Author

bcoe commented Jan 16, 2016

@tcurdt in the test stanza of your package.json, you should never need to provide the absolute path ./node_modules/.bin -- so as long as you follow the documentation in the README.md, life should be good.

@tcurdt
Copy link

tcurdt commented Jan 16, 2016

@bcoe odd - it does indeed work without the prefix. Could have sworn that was giving me trouble. Well, nevermind then.

@bcoe
Copy link
Member Author

bcoe commented Jan 16, 2016

@jamestalmage can we ship this?

@jamestalmage
Copy link
Member

LGTM

Is there a good resource to link to on using node_modules/.bin/ for local installs?

@sindresorhus If there's not something out there you should write one and add it to https://github.com/sindresorhus/guides. This issue comes up all the time, and it would be nice to have a concise clearly written resource to point people at.

@bcoe Ship it. If we find a good link, we'll just add it when we do.

@sindresorhus
Copy link
Member

@jamestalmage I cover it briefly here, but I'll look into doing a more comprehensive guide.

bcoe added a commit that referenced this pull request Jan 16, 2016
updated documentation based on the discussion in #134
@bcoe bcoe merged commit a2af645 into master Jan 16, 2016
@bcoe bcoe deleted the 134-fix branch January 16, 2016 03:48
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

Successfully merging this pull request may close these issues.

Add better examples to the documentation
4 participants