Skip to content

Rewrite README and update package description - #13

Merged
lfbittencourt merged 5 commits into
mainfrom
issue-12-rewrite-readme
Feb 18, 2026
Merged

lfbittencourt merged 5 commits into
mainfrom
issue-12-rewrite-readme

Conversation

@lfbittencourt

Copy link
Copy Markdown
Owner

Summary

  • Replaces the vague internal-concept description ("nested And and Or objects") with a clear one-liner and an immediate code example
  • Fixes yarn install → yarn add
  • Adds an explicit API signature (expand(pattern: string): string[])
  • Surfaces the CommonJS-only limitation as a visible blockquote referencing Add ESM support #12, instead of a buried code comment
  • Adds the list of special characters to the Escaping section
  • Adds a License section
  • Updates package.json description to match (this feeds the GitHub short description)

Test plan

  • Read through the rendered README on GitHub and verify all examples look correct
  • Confirm the #12 link resolves to the ESM support issue

🤖 Generated with Claude Code

lfbittencourt and others added 5 commits February 18, 2026 17:04
- Replace vague internal-concept description with a clear one-liner and
  immediate code example
- Fix yarn install → yarn add
- Add explicit API signature (pattern: string): string[]
- Surface the CommonJS-only limitation as a visible note referencing #12
  instead of burying it in a code comment
- Add special characters list to the Escaping section
- Add License section
- Update package.json description to match

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add use cases section before Installation (name matching, search
  expansion, test data, localization)
- Document expansion order and no deduplication in the API section
- Warn about exponential output growth
- Clarify 3+ option igroup behavior: outputs each option individually
  plus their full concatenation, not every pairwise combination

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@lfbittencourt
lfbittencourt merged commit ec3f941 into main Feb 18, 2026
1 check passed
@lfbittencourt
lfbittencourt deleted the issue-12-rewrite-readme branch February 18, 2026 20:37
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