fix(readme): update README to comprehensive, TypeScript-first documentation covering installation, quick start, examples, API usage, events, error handling, requirements, credits, and legal/company information

This commit is contained in:
2026-01-09 17:21:26 +00:00
parent e424085000
commit 79b05d47aa
3 changed files with 601 additions and 4 deletions

View File

@@ -1,5 +1,14 @@
# Changelog
## 2026-01-09 - 2.3.1 - fix(readme)
update README to comprehensive, TypeScript-first documentation covering installation, quick start, examples, API usage, events, error handling, requirements, credits, and legal/company information
- Rewrote readme.md with ~590 additional lines to provide a full usage guide and examples
- Added installation instructions for pnpm, npm, and yarn and badges for npm and license
- Documented OOP usage pattern (Discovery → Selection → Feature → Operation), event handling, and error handling examples
- Clarified requirements (Node.js 18+, TypeScript 5.0+), credits, license, trademark and company contact information
- Docs-only change — no code or API modifications
## 2026-01-09 - 2.3.0 - feat(devicemanager)
add selector-based device APIs, selectFeature helper, convenience discovery methods, and ESCL scan completion fallback