Commit Graph
5 Commits
Author SHA1 Message Date
Tobias Gesellchen 79140cfa78 docs: update documentation for Go 1.25.6 and code quality improvements
- Update Go version requirement from 1.25.5 to 1.25.6 in all docs (security fix)
- Add golangci-lint tooling information to CONTRIBUTING.md
- Document code quality improvements in STATUS.md including:
  - Security vulnerability resolution (GO-2026-4340)
  - Cyclomatic complexity reduction for 5 functions
  - Comprehensive error handling improvements
  - Complete style and formatting compliance
- Add code quality metrics section showing production readiness
- Update development workflow to include modern linting tools

Ensures documentation accurately reflects current security and quality status.
2026-02-01 22:17:46 +01:00
Tobias Gesellchen 5f7f3977e0 docs: Standardize Go version requirement to 1.25.5+ throughout documentation
- Update CONTRIBUTING.md to require Go 1.25.5 or later
- Update README.md prerequisites
- Update GETTING-STARTED.md requirements
- Update Dockerfile examples to use golang:1.25-alpine
- Update issue templates to reflect supported Go versions
- Ensure consistency across all documentation files

All CI workflows already use go-version-file: go.mod so they
automatically pick up the correct version from go.mod.
2026-01-11 17:10:28 +01:00
Tobias Gesellchen ccd19d97a5 docs: add attribution to official Bose SoundTouch Web API documentation
- Reference original API documentation source from Bose Corporation
- Link to official Bose SoundTouch End-of-Life page
- Clarify this is an independent implementation
- Add disclaimer about non-affiliation with Bose Corporation
- Provide both online and local documentation references
2026-01-10 00:34:54 +01:00
Tobias Gesellchen 9ecdd7af47 Update CLI documentation to reflect current subcommand structure
- Update README.md CLI examples from old flag-based format to current subcommand structure
- Fix GETTING-STARTED.md CLI examples to use proper syntax
- Add comprehensive CLI-REFERENCE.md with complete command documentation
- All examples now use correct format: soundtouch-cli --host <device> <command> <subcommand>
- Document all available commands: discover, info, play, volume, source, bass, balance, clock, network, zone
- Include usage patterns, examples, and troubleshooting guidance
- Replace outdated flat flag format (-info, -volume) with hierarchical commands (info, volume get)

Breaking: CLI syntax has changed from flags to subcommands for better organization
2026-01-10 00:11:20 +01:00
Tobias Gesellchen 01abf2d51f Add comprehensive documentation and polish
Major documentation additions:
- GETTING-STARTED.md: Complete 10-minute tutorial from discovery to WebSocket monitoring
- API-COOKBOOK.md: 1000+ lines of real-world patterns, recipes, and best practices
- TROUBLESHOOTING.md: Systematic guide for diagnosing and fixing common issues
- DEPLOYMENT.md: Production-ready deployment patterns and operational guidance

Key highlights:
- Step-by-step examples with working code
- Error handling and resilience patterns
- Performance optimization strategies
- Security and monitoring best practices
- Docker, Kubernetes, and systemd deployment examples
- Complete troubleshooting checklist with diagnostic commands
- Production-ready configuration management

This represents a significant investment in developer experience and makes the
SoundTouch Go client accessible to developers of all experience levels.
2026-01-09 12:58:35 +01:00