Skip to content

Refresh the README for open-source launch#39

Merged
darekaze merged 4 commits into
mainfrom
fix/issue-35
Jul 1, 2026
Merged

Refresh the README for open-source launch#39
darekaze merged 4 commits into
mainfrom
fix/issue-35

Conversation

@darekaze

Copy link
Copy Markdown
Member

Summary

  • Restructure the README with a prominent native-build warning, clear installation steps, and a scannable Reader flow (permissions → scan → connect → card).
  • Make unsupported targets (Expo Go, web) and platform/hardware requirements explicit.
  • Present the manual hardware checklist as numbered steps for Android and iOS.
  • Keep ACS SDK bundling and third-party notices discoverable.
  • Align install wording with npmjs.com; remove JSR as a described distribution path.
  • Avoid claiming CI or release automation that is not yet on main (local pnpm run lint / pnpm run build only in the Development section).

Closes #35

Manual action

None for this documentation-only change. After merging, skim the rendered README on GitHub to confirm admonition blocks display as intended.

Test plan

  • README renders with GitHub admonition syntax (> [!IMPORTANT])
  • Domain terms match CONTEXT.md (Reader, MIFARE Classic Card, Hex String, APDU Response Data, APDU Status)
  • Maintainer review for tone and length

Made with Cursor

darekaze and others added 4 commits June 30, 2026 22:12
Clarify installation, native build requirements, unsupported targets,
Reader flow, and manual hardware validation without overstating repo
automation.

Co-authored-by: Cursor <cursoragent@cursor.com>
Link the shields.io badge to the published @countertek package on npmjs.com.

Co-authored-by: Cursor <cursoragent@cursor.com>
Remove the extra Requirements block and repeated native-build note left
from merging main into fix/issue-35; keep one Installation + Requirements flow.

Co-authored-by: Cursor <cursoragent@cursor.com>
@darekaze darekaze merged commit 45ee910 into main Jul 1, 2026
1 check passed
@darekaze darekaze deleted the fix/issue-35 branch July 1, 2026 08:34
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.

Refresh the README for open-source launch

1 participant