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

adds installation instructions to README #219

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

steveliles
Copy link

The mismatch between the github repo name and the npm name adds a little friction that's easily solved by an installation section in the README.

Thanks for the lib, its just what i need :)

## Installation

```
npm install --save sax
Copy link

@jacktuck jacktuck Oct 24, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--save is redundant in latest npm i think, @isaacs would know 😆

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just tried it - you're right, and thanks - I didn't know that had changed!

I looked quickly at the release notes and didn't yet spot when that change arrived ... maybe safer to keep it explicit until the majority are running an npm version for which --save is the default?

Either way is good - the main point for me was to get the npm name on the readme somewhere :)

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.

2 participants