Docs don't say how to install; no readme on NPM page

molefrog / wouter

🥢 A minimalist-friendly ~2.1KB routing for React and Preact

https://npm.im/wouter

The Unlicense

6.65k stars 152 forks source link

Docs don't say how to install; no readme on NPM page #418

Closed kevin51jiang closed 7 months ago

kevin51jiang commented 7 months ago

First of all, thanks for the work on wouter! Love the simplicity.

I think the docs are missing something, namely a copy-pasteable code block that says

npm install wouter

that just makes it much more convenient when I want to install this package. Although I know the package is called wouter, I don't know if it's under some org (e.g. @kevin51jiang/wouter).

Also, on the NPM page it seems like it doesn't have a README, would be great if one could be added.

molefrog commented 7 months ago

Added installation instructions to the README and fixed the build (because it's monorepo, the README file was in the root workspace package and not wouter). Thank you!