Repository navigation
chore: update package description, keywords and size badge - #15
Merged
Merged
Conversation
- Description: drop "node module", say it's under 2 kB, dependency-free and works in all modern runtimes. npm search weighs the description and keywords most. - Keywords: add the terms people search for (form-data, multipart, urlsearchparams, remix, react-router, nextjs, server-actions, tiny, zero-dependency, ...). - README: a static "< 2 kB" size badge linked to .size-limit.json (CI enforces the limit; Bundlephobia badges are rate-limited), the size in the intro, and blob/master links changed to main.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #15 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 4 4
Lines 125 125
Branches 44 44
=========================================
Hits 125 125 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
🎉 This PR is included in version 1.1.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Makes the package easier to find on npm and GitHub. Should merge before the 1.1.0 release: npm only updates the description and keywords with a published version.
chore:doesn't release by itself.Changes
form-data,lightweight,multipart,nextjs,no-dependencies,parser,react-router,remix,server-actions,tiny,typescript,urlsearchparams,zero-dependency.qsis deliberately not a keyword..size-limit.json.maininstead ofmaster.Why a static size badge
The claim is "under 2 kB" and not today's size (ESM 1.33 kB, umd.min 1.50 kB). That way 1.2, which must raise the umd.min limit, doesn't make it false. The limit in
.size-limit.jsonshould stay at or below 2 kB to keep the claim true.The dynamic badges don't work well:
The static badge links to the CI-enforced limit instead.
npm run validatepasses.