Skip to content

Conversation

@Omaima-Ameen
Copy link

@Omaima-Ameen Omaima-Ameen commented Dec 6, 2025

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and discussions and couldn’t find anything or linked relevant results below
  • I made sure the docs are up to date
  • I included tests (or that’s not needed)

Description of changes

This PR improves the Installation section of the README by:

Improving formatting for readability

Adding a short usage snippet for Node environments

Clarifying that the package is ESM-only

This is a documentation-only change with no modifications to runtime code.

@github-actions github-actions bot added the 👋 phase/new Post is being triaged automatically label Dec 6, 2025
@github-actions

This comment has been minimized.

@Omaima-Ameen
Copy link
Author

Hi! I noticed the CI failed, but my changes only modify the README and do not affect code or tests.
It looks like the failure might be unrelated.
Please let me know if anything is needed from my side!

@github-actions github-actions bot added 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Dec 6, 2025
@Murderlon
Copy link
Member

The unified ecosystem consists of 300+ repositories and great care is taken to keep the readme's as consistent as possible. This deviates from that for, in my opinion, no gains. At this point it must be obvious that anyone who uses yarn/pnpm knows what to do when they find a readme that only showcases npm. As far as I know we don't keep track of which Vite/Webpack version we support so adding this just means signing up for the maintenance burden of tracking that too, and that's of course besides the fact that there are many more bundlers these days.

@Murderlon Murderlon closed this Dec 7, 2025
@github-actions

This comment has been minimized.

@Murderlon Murderlon added 🙅 no/wontfix This is not (enough of) an issue for this project 👎 phase/no Post cannot or will not be acted on and removed 🤞 phase/open Post is being triaged manually labels Dec 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🙅 no/wontfix This is not (enough of) an issue for this project 👎 phase/no Post cannot or will not be acted on

Development

Successfully merging this pull request may close these issues.

2 participants