Skip to content

docs: update README with comprehensive documentation#22

Closed
cristinecula wants to merge 1 commit intomainfrom
docs/update-readme
Closed

docs: update README with comprehensive documentation#22
cristinecula wants to merge 1 commit intomainfrom
docs/update-readme

Conversation

@cristinecula
Copy link
Contributor

Summary

Updates the README from a minimal 3-line placeholder to comprehensive documentation.

Changes

  • Add badges (CI status, semantic-release)
  • Add features overview (list/split/queue modes, keyboard nav, URL hash sync)
  • Add installation instructions
  • Add basic usage example with component stylesheets
  • Add API reference:
    • Hooks table (useQueue, useListState, useTabs, useSplit, useDataNav, useList)
    • useQueue options table
    • useQueue returns table
  • Add subpath exports reference
  • Add development section with test commands

- Add badges (CI status, semantic-release)
- Add features overview
- Add installation and basic usage example
- Add API reference for hooks and useQueue options/returns
- Add subpath exports reference
- Add development section with test commands
@github-actions
Copy link

github-actions bot commented Feb 6, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-02-12 08:33 UTC

@cristinecula cristinecula self-assigned this Feb 6, 2026
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