Make polka ultra light weight
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 5.6k
- Forks
- 176
- PR merge metrics
- No merged PRs in 30d
Description
When polka package is published to npm, it includes the readme file which weights around 22 kB.
https://github.com/lukeed/polka/blob/master/packages/polka/readme.md
Moving this documentation to GitHub Wiki or some other place would reduce the unpacked size from 25.5 kB to 4.31 kB.
Update readme to include minimal details & add external references to the much more detailed documentation.
Thanks for this awesome package.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review packages/polka/readme.md, the README included in the npm package. Shorten it to minimal package details and add external references to the fuller documentation, while preserving the useful project context. Done means the published package no longer carries the full roughly 22 kB README and its unpacked size is reduced toward the stated 4.31 kB.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100