From a2fe793cb580483405b017b566af2b38f07c33c8 Mon Sep 17 00:00:00 2001 From: Tobias Gesellchen Date: Sun, 17 May 2026 12:16:32 +0200 Subject: [PATCH] docs: add disclaimer, contributing summary, and sponsorship Two user-facing additions modelled on the streborn project's README: - **Disclaimer section in README.** Stronger Bose-trademark clause, explicit "not affiliated, endorsed, sponsored, or connected" statement, and the EU 2009/24/EC Art. 6 interoperability clause with a stable EUR-Lex hyperlink. Adds a Stockholm-specific sentence: users supply the Stockholm web-app sources themselves, no Bose code is redistributed in this repo. - **Ways to Contribute / Support the project in README and CONTRIBUTING.** Itemises the contribution categories users actually have (code, docs, bug reports, donations) and adds the GitHub Sponsors badge for gesellix. Sponsorship is explicitly optional and licensing-neutral. The thin "Not affiliated" line at the top of the README now points at the full Disclaimer section rather than carrying the whole statement. Co-Authored-By: Claude Opus 4.7 (1M context) --- CONTRIBUTING.md | 20 ++++++++++++++++++++ README.md | 35 ++++++++++++++++++++++++++++++++--- 2 files changed, 52 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8773edd..1da65fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,17 @@ Thank you for your interest in contributing to the Bose SoundTouch API Client! This project aims to provide a comprehensive, reliable, and well-tested Go library for controlling Bose SoundTouch devices. +## Ways to Contribute + +All contributions are welcome — large or small: + +- **Code suggestions** — bug fixes, new features, refactoring, performance improvements. +- **Documentation updates** — README, guides, examples, troubleshooting notes, inline doc comments. +- **Bug fixes** — even just a clear reproducer in an issue is a real contribution. +- **Donations** — if the project kept a speaker (or several) of yours alive past the Bose cloud shutdown and you want to give back, [GitHub Sponsors](https://github.com/sponsors/gesellix) is open. No expectation; everything in this repo stays MIT regardless. + +By submitting a code or documentation contribution you agree to license it under MIT. The detailed guides below cover the mechanics. + ## Table of Contents - [Code of Conduct](#code-of-conduct) @@ -15,6 +26,7 @@ Thank you for your interest in contributing to the Bose SoundTouch API Client! T - [Reporting Issues](#reporting-issues) - [Device Testing](#device-testing) - [Community](#community) +- [Support the Project](#support-the-project) ## Code of Conduct @@ -465,6 +477,14 @@ Contributors will be: - **Mentioned in release notes** for significant contributions - **Credited in documentation** where appropriate +## Support the Project + +If you want to support the maintenance effort beyond code: + +[![GitHub Sponsors](https://img.shields.io/github/sponsors/gesellix?label=Sponsor%20on%20GitHub&logo=GitHub&color=ea4aaa)](https://github.com/sponsors/gesellix) + +Sponsorship is entirely optional. Code, docs, and bug reports remain the most useful contributions for the project itself. + ## Additional Resources - [Go Documentation](https://golang.org/doc/) diff --git a/README.md b/README.md index bce4bd2..58b81b4 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/gesellix/bose-soundtouch)](https://goreportcard.com/report/github.com/gesellix/bose-soundtouch) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -> Independent project. Not affiliated with or endorsed by Bose Corporation. +> Independent project. **Not affiliated with, endorsed by, sponsored +> by, or otherwise connected to Bose Corporation.** See +> [Disclaimer](#disclaimer) for the full statement. ## Context: Cloud Shutdown @@ -122,8 +124,35 @@ See the [API Reference](https://gesellix.github.io/Bose-SoundTouch/reference/API --- +## Contributing + +Issues and pull requests welcome — code, documentation, bug reports, and feature ideas all land in the same place. By submitting a contribution you agree to license it under MIT. For significant changes please open an issue first to discuss the approach. See [CONTRIBUTING.md](CONTRIBUTING.md) for the full guide. + +## Support the project + +If this toolkit kept a speaker (or several) of yours alive past the Bose cloud shutdown and you want to give back, [GitHub Sponsors](https://github.com/sponsors/gesellix) is open. No expectation — everything in this repo stays MIT regardless. + +[![GitHub Sponsors](https://img.shields.io/github/sponsors/gesellix?label=Sponsor%20on%20GitHub&logo=GitHub&color=ea4aaa)](https://github.com/sponsors/gesellix) + +## Disclaimer + +This is an independent open-source project. **Bose** and **SoundTouch** +are registered trademarks of Bose Corporation in the United States and +other countries. This project is **not affiliated with, endorsed by, +sponsored by, or otherwise connected to** Bose Corporation. + +The toolkit exists solely to restore functionality of Bose SoundTouch +speakers after the official cloud service shutdown on May 6, 2026. +Reverse engineering for the sole purpose of interoperability is +permitted under [EU Directive 2009/24/EC, Article 6](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:32009L0024) +("Decompilation"), and comparable provisions in other jurisdictions. + +The optional Stockholm frontend integration (`STOCKHOLM_DIR`) requires +the user to supply the Stockholm web-app sources themselves; no Bose +code is redistributed in this repository. + +The software is provided AS IS, without warranty. Use at your own risk. + ## License MIT — see [LICENSE](LICENSE). - -SoundTouch is a trademark of Bose Corporation.