Skip to content

docs: expand README with comprehensive feature documentation#5

Merged
nedpals merged 1 commit into
masterfrom
claude/readme-documentation-update-h68jdg
Jun 29, 2026
Merged

docs: expand README with comprehensive feature documentation#5
nedpals merged 1 commit into
masterfrom
claude/readme-documentation-update-h68jdg

Conversation

@nedpals

@nedpals nedpals commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator

Summary

Updated the README.md to comprehensively document the full feature set and capabilities of the NFC agent, including recently implemented functionality and improved command-line documentation.

Key Changes

  • Enhanced feature list: Expanded NDEF support documentation to include smart poster, vCard, MIME, geo, tel/sms/mailto, Android Application Records, and custom raw records
  • Reliability features: Added documentation for read-after-write verification, automatic retry on transient failures, and pre-flight capacity checks
  • Tag management: Documented tag locking, erase, and capability reporting features
  • Security: Added documentation for automatic TLS (WSS) with CA bootstrap server and optional API-secret authentication
  • Device discovery: Added mDNS/Bonjour auto-discovery feature to documentation
  • Card type support: Updated supported card types to include MIFARE Classic NDEF formatting and custom keys, plus NTAG21x
  • Command-line options: Completely restructured and expanded with new flags:
    • -version flag for version information
    • -device flag with improved documentation (PC/SC reader names)
    • -device-port flag for custom device server port
    • -auto-tls flag for TLS certificate management control
    • -cert and -key flags for custom TLS certificates
    • -config-dir flag for configuration directory override
  • Server documentation: Updated to reflect three servers (added CA Bootstrap Server on port 9472)
  • Configuration persistence: Added documentation explaining automatic TLS certificate and API secret generation and persistence across restarts

Implementation Details

These changes are documentation-only and reflect the actual capabilities of the application. The README now provides users with complete information about available features, configuration options, and supported hardware/formats.

https://claude.ai/code/session_01KoUv6XnHGJoEhE3fLEWMQz

- Fix command-line options: remove non-existent -cli flag, document the
  actual flags (-version, -device-port, -bootstrap behavior, -auto-tls,
  -cert/-key, -config-dir) and correct -device to a PC/SC reader name
- Expand Features to cover shipped capabilities: rich NDEF record types,
  read-after-write verification with retry, tag locking/erase, tag
  capability reporting, auto-TLS (WSS) with CA bootstrap, and mDNS discovery
- Note the three servers (add CA Bootstrap on 9472) and persisted
  TLS cert / API secret behavior
- Update card types (NTAG21x, MIFARE Classic NDEF formatting/custom keys)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KoUv6XnHGJoEhE3fLEWMQz
@nedpals nedpals changed the title Expand README with comprehensive feature documentation docs: expand README with comprehensive feature documentation Jun 29, 2026
@nedpals
nedpals merged commit 202323e into master Jun 29, 2026
2 of 3 checks passed
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