Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve exports organization and documentation #12

Merged
merged 2 commits into from
Feb 16, 2025

Conversation

phr3nzy
Copy link
Owner

@phr3nzy phr3nzy commented Feb 16, 2025

  • Enhanced export organization with better grouping
  • Improved JSDoc documentation
  • Separated v2 legacy exports
  • Updated documentation and examples
  • Bumped version to 3.3.0

- Enhanced export organization with better grouping
- Improved JSDoc documentation
- Separated v2 legacy exports
- Updated documentation and examples
- Bumped version to 3.3.0
Copy link

codecov bot commented Feb 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.49%. Comparing base (ed5c18c) to head (53c11ee).
Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #12   +/-   ##
=======================================
  Coverage   98.48%   98.49%           
=======================================
  Files          14       15    +1     
  Lines        1191     1193    +2     
  Branches      412      340   -72     
=======================================
+ Hits         1173     1175    +2     
  Misses         18       18           
Flag Coverage Δ
unittests 98.49% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
src/index.ts 100.00% <100.00%> (ø)
src/v2.ts 100.00% <100.00%> (ø)

- Added clearer project description and use cases
- Improved Quick Start with practical example
- Added examples section with smart filtering demo
- Enhanced component documentation
- Reorganized sections for better readability
@phr3nzy phr3nzy merged commit ea9cd18 into main Feb 16, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant