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

Consider having installation section with at least the npm package name #208

Closed
jinalskothari opened this issue May 14, 2017 · 5 comments
Closed

Comments

@jinalskothari
Copy link

It may not be obvious to all that this lib lives in the npm registry with the same package name. It may be helpful to have a section in readme with this information. Happy to make a PR.

@ljharb
Copy link
Owner

ljharb commented May 14, 2017

Everything worth using lives in the npm registry, so that should be the default assumption :-)

However, I thoroughly agree that the readme should be more informative here - if you'd follow the example in https://raw.githubusercontent.com/ljharb/is-typed-array/master/README.md for the version number, the npm badge, and for funsies, the dep/dev dep badges and the license image (using the same footnote style), that'd be appreciated!

@ljharb
Copy link
Owner

ljharb commented May 15, 2017

@jinalskothari please let me know if you're interested in making a PR for this.

@jinalskothari
Copy link
Author

@ljharb, I can take it up in 3 days and make PR. I'll check and post here before starting to avoid duplicated effort.

@ljharb
Copy link
Owner

ljharb commented May 19, 2017

@jinalskothari should i take care of this?

@jinalskothari
Copy link
Author

Sorry I couldn't find time. @ljharb Yes please.

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

No branches or pull requests

2 participants