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

Add "what np isn't" section to the readme #672

Merged
merged 3 commits into from
Feb 3, 2023
Merged

Add "what np isn't" section to the readme #672

merged 3 commits into from
Feb 3, 2023

Conversation

fregante
Copy link
Collaborator

@fregante fregante commented Feb 3, 2023

After triaging every single open issue in the repo, I collected the main and recurring issues and requests that people have with np and decided it might be best to add them to the readme. np isn't for everyone and it should be clear about that. People take "a better npm publish" a little too literally.

Relevant issues:

readme.md Outdated
- Monorepos are not supported.
- Custom registries are not supported ([but could be with your help](https://github.com/sindresorhus/np/issues/420)).
- CI is [not an ideal environment](https://github.com/sindresorhus/np/issues/619#issuecomment-994493179) for `np`. It's meant to be used locally as an interactive tool.
- `np` is meant to be installed globally and used by a single person, not shared as a dev dependency ([for now](https://github.com/sindresorhus/np/issues/592)).
Copy link
Owner

Choose a reason for hiding this comment

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

I have used np as a dev dependency before. Maybe it's only an issue with Yarn?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
- `np` is meant to be installed globally and used by a single person, not shared as a dev dependency ([for now](https://github.com/sindresorhus/np/issues/592)).
- `np` is meant to installed via `npm` because yarn… ahem

@sindresorhus sindresorhus merged commit 62db480 into main Feb 3, 2023
@sindresorhus sindresorhus deleted the why-not branch February 3, 2023 13:56
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.

None yet

2 participants