docs: updated the main README instructions and examples

[ioncache]

Overview

Polishes the v1 package-facing documentation and metadata so users can more easily install, evaluate, and apply data-sanitization for sensitive-data masking/removal workflows.

Details

• Expands the README with package-manager install sections, import guidance, clearer usage examples, and a PII/PHI custom-pattern example for both masking and removal.
• Updates package metadata with homepage/bugs links and broader sensitive-data keywords.
• Clarifies contributor setup and validation docs around Volta, Yarn scripts, build output, and release checks.
• Adds the numbered implementation plan for this README/release-polish slice.
• Cleans up an existing markdown bare URL in the coverage plan and keeps roadmap wording aligned with the README’s sensitive-data positioning.

Related Tickets and/or Pull Requests

Relates to docs/ROADMAP.md

Summary by CodeRabbit

Release Notes

• Documentation
  • Expanded package documentation with improved installation instructions for multiple package managers and comprehensive usage examples.
  • Added detailed guidance on custom pattern configuration for sensitive data sanitization.
  • Clarified setup, build, and pre-release validation procedures.
  • Updated package metadata with homepage and bug-tracking information for improved discoverability.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: b124e6f2-e586-47a3-9b99-75f4b0042c70

📥 Commits

Reviewing files that changed from the base of the PR and between 525ec60 and 59ed911.

📒 Files selected for processing (6)

• README.md
• docs/ROADMAP.md
• docs/development.md
• docs/plans/001-coverage-tracking.md
• docs/plans/004-readme-release-polish.md
• package.json

---

📝 Walkthrough

Walkthrough

This pull request updates documentation and package metadata for the data-sanitization package. The README is restructured with multi-platform installation guidance, expanded importing options, and new sections demonstrating custom pattern and matcher usage. Development documentation is enhanced with tool-version pinning and release validation steps. Package metadata fields are added and wording is refined throughout to emphasize PII/PHI sanitization capabilities.

Changes

Documentation and Package Metadata Release Polish

Layer / File(s)	Summary
README expansion and restructuring README.md	README introduction, table of contents, installation (npm/yarn/pnpm/bun), importing (named/default/CommonJS), string format support, new PII/PHI custom patterns section with masking and removal examples, options reformatted into a table, default and custom matchers documentation refined, error handling clarified, and "How it works" expanded to detail object recursion and null handling.
Development and roadmap guidance updates docs/development.md, docs/ROADMAP.md	Setup documentation adds Volta tool-version pinning; build section clarifies JavaScript, TypeScript declaration, and source-map outputs; release process adds pre-publishing validation checklist. Roadmap "Current State" rewording emphasizes sensitive-data sanitization for logging and debugging workflows.
Package metadata and registry fields package.json	Package description updated to specify masking/removing sensitive data; pii and phi keywords added; homepage and bugs.url fields added.
Planning documentation and minor fixes docs/plans/001-coverage-tracking.md, docs/plans/004-readme-release-polish.md	New plan document 004-readme-release-polish.md specifies scope, checklist, verification steps, and decisions for release polish work; 001-coverage-tracking.md GitHub PAT URL reflowed for link formatting compliance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Our docs now hop with clarity divine,
PII and PHI patterns shine and align,
With Volta's pins and release checklists true,
The package gleams—ready for public debut! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title broadly refers to README updates but omits the significant changes to package.json metadata and other documentation files included in the PR.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/readme-release-polish

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	100% (🎯 100%)	107 / 107
🔵	Statements	100% (🎯 100%)	109 / 109
🔵	Functions	100% (🎯 100%)	14 / 14
🔵	Branches	100% (🎯 100%)	72 / 72

File Coverage

No changed files found.

Generated in workflow #138 for commit 59ed911 by the Vitest Coverage Report Action