Skip to content

docs: improve README#11

Merged
Skitionek merged 1 commit intomainfrom
copilot/improve-readme
Apr 12, 2026
Merged

docs: improve README#11
Skitionek merged 1 commit intomainfrom
copilot/improve-readme

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 12, 2026

README had several accuracy and completeness gaps: wrong (unscoped) install command, unused badge definitions, a single tangled usage code block, and no API reference.

Changes

  • Install command — corrected to @skitionek/route-with-dynamic-outlets
  • Badges — moved all defined badges (build, npm, downloads, issues, codecov, semantic-release, commitizen) to the header where they're visible
  • Badge URLs — updated npm/downloads URLs to the scoped package name
  • Usage — split the single muddled block into four labelled steps: dynamic outlet component, route definition, nesting, and custom matcher; fixed invalid triple-backtick inside a fenced code block
  • How it works — added a concise section describing the matcher-based mechanism (URL match → outlet diff → BehaviorSubject push → component subscription)
  • API reference — added docs for createRouteWithDynamicOutlets, RouteWithDynamicOutlets, DynamicOutletRouteFactory, and OutletsMap with parameter tables and type signatures

…es, and how-it-works section

Agent-Logs-Url: https://github.com/Skitionek/route-with-dynamic-outlets/sessions/a68a406b-a77d-4b89-81e5-90a78be41e20

Co-authored-by: Skitionek <22711241+Skitionek@users.noreply.github.com>
@Skitionek Skitionek marked this pull request as ready for review April 12, 2026 12:09
@Skitionek Skitionek self-requested a review as a code owner April 12, 2026 12:09
@Skitionek Skitionek merged commit 5e6485c into main Apr 12, 2026
20 checks passed
@Skitionek Skitionek deleted the copilot/improve-readme branch April 12, 2026 12:11
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.

2 participants