Skip to content

Update README with modern examples and requirements#29

Merged
tomkp merged 1 commit intomasterfrom
docs/update-readme
Dec 28, 2025
Merged

Update README with modern examples and requirements#29
tomkp merged 1 commit intomasterfrom
docs/update-readme

Conversation

@tomkp
Copy link
Copy Markdown
Owner

@tomkp tomkp commented Dec 28, 2025

Summary

Modernize documentation with async/await examples and add missing requirements.

Changes

  • Update examples to use async/await instead of .then()/.catch()
  • Add PC/SC driver requirements for macOS, Windows, and Linux
  • Add TypeScript usage example with proper type annotations
  • Document maxRetries parameter for issueCommand()
  • Add createCommandApdu usage example
  • Document ResponseApdu methods
  • Update demo file to use async/await and import from dist/

Test plan

  • All 30 tests pass
  • README examples are syntactically correct

Fixes #28

- Update examples to use async/await instead of .then()/.catch()
- Add PC/SC driver requirements for different platforms
- Add TypeScript usage example with type annotations
- Document maxRetries parameter for issueCommand()
- Add createCommandApdu usage example
- Document ResponseApdu methods
- Update demo file to use async/await and import from dist/

Fixes #28
@tomkp tomkp merged commit 608a618 into master Dec 28, 2025
3 checks passed
@tomkp tomkp deleted the docs/update-readme branch December 28, 2025 14:48
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.

Update README with modern examples and requirements

1 participant