Skip to content

docs: update READMEs with performance metrics, architecture and badges#46

Merged
matcastaneda merged 2 commits intomainfrom
docs/update-readmes
Apr 14, 2026
Merged

docs: update READMEs with performance metrics, architecture and badges#46
matcastaneda merged 2 commits intomainfrom
docs/update-readmes

Conversation

@matcastaneda
Copy link
Copy Markdown
Owner

📋 Summary

Related Issue: Closes #

🏗️ Type of change

  • 🆕 Feature (new validation rule, utility, or integration)
  • 🐛 Bug fix (fixes incorrect RUT calculation, formatting, etc.)
  • 📝 Documentation (README, JSDoc comments, examples)
  • 🧰 TypeScript (type definitions, generics improvements)
  • 🧪 Testing (new test cases, coverage improvements)
  • ⚙️ Infrastructure (tsdown, Turbo, GitHub Actions, Biome)

🎯 What

🤔 Why

🔧 How

🧪 Testing

  • I have tested these changes locally
  • I have added or updated tests in Vitest for new/changed functionality
  • pnpm test passes and maintains the 90% coverage threshold
  • pnpm build completes successfully (ESM output is valid)

Test instructions

🖼️ Screenshots / recordings

📝 Additional notes

✅ Pre-submission checklist

  • My code follows the project's style guidelines (Biome)
  • I have performed a self-review of my code
  • I have exported any new functions or types in the package's index.ts
  • I have added JSDoc comments to new public APIs
  • My changes generate no new TypeScript or Knip warnings
  • AI/LLM Policy: If I used AI assistance, I have tested and executed the code locally (no "vibe-coding")

By submitting this PR, I agree that my contributions will be licensed under the project's MIT License.

@github-actions github-actions bot added the type: docs Improvements or additions to documentation label Apr 14, 2026
@github-actions
Copy link
Copy Markdown
Contributor

📊 Package Size Report

Compared against base main (Commit: b5f61eb by @matcastaneda)

Package / Export Limit Size (Gzip) Trend Status
📦 CORE - Main Export 1.95 kB 1.84 kB unchanged 🟢
📦 CORE - Validate 1.07 kB 967 B unchanged 🟢
📦 CORE - Format 800 B 707 B unchanged 🟢
📦 CORE - Clean 300 B 217 B unchanged 🟢
📦 CORE - Barcode 700 B 587 B unchanged 🟢
📦 CORE - Business 800 B 686 B unchanged 🟢
📦 CORE - Errors 1.07 kB 958 B unchanged 🟢
🧩 ZOD - Adapter (Isolated) 700 B 553 B unchanged 🟢

Total Bundle Weight: 6.41 kB
Zero Dependencies | 🛡️ Type Safe | ⚡ Ultra Lightweight

Generated on Tue, 14 Apr 2026 00:49:42 GMT

@matcastaneda matcastaneda merged commit 27b5897 into main Apr 14, 2026
3 checks passed
@matcastaneda matcastaneda deleted the docs/update-readmes branch April 14, 2026 00:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant