Skip to content

Commit

Permalink
feat: 2024 Q1 update
Browse files Browse the repository at this point in the history
  • Loading branch information
svrooij committed Feb 7, 2024
1 parent 31e1a96 commit cff07fb
Show file tree
Hide file tree
Showing 21 changed files with 7,178 additions and 5,277 deletions.
14 changes: 3 additions & 11 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ If you find an Issue that addresses the problem you're having, please add your o
PRs to our libraries are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:

- Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
- If you changed the [documentation.json](https://svrooij.io/sonos-api-docs/developers.html#documentationjson) or any device discovery files, be sure to also [regenerate](https://svrooij.io/sonos-api-docs/developers.html#regenerate-documentation) the services.
- Be sure to [preview](https://svrooij.io/sonos-api-docs/developers.html#live-preview-on-local-machine) your changes in the resulting webpage.
- If you changed the [documentation.json](https://sonos.svrooij.io/developers.html#documentationjson) or any device discovery files, be sure to also [regenerate](https://sonos.svrooij.io/developers.html#regenerate-documentation) the services.
- Be sure to [preview](https://sonos.svrooij.io/developers.html#live-preview-on-local-machine) your changes in the resulting webpage.
- Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).

For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
Expand All @@ -54,22 +54,14 @@ In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susa
6. Push changes to your fork
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.

## Getting Help

[![Join us on Discord][badge_discord]][link_discord]

If you need help building an app that talks to your sonos speakers, or you want to share some of your findings. [Join us on Discord][link_discord].

## Sponsoring

[![Support me on Github][badge_sponsor]][link_sponsor]

You cannot only contribute by spending some time to document stuff or the help users with his/her issues, you can also sponsor me, so I can spend time on my open-source projects like these.

[badge_discord]: https://img.shields.io/discord/782374564054564875
[badge_issues]: https://img.shields.io/github/issues/svrooij/sonos-api-docs
[badge_sponsor]: https://img.shields.io/badge/Sponsor-on%20Github-red

[link_discord]: https://discord.gg/ZUdEuhh5RF
[link_sponsor]: https://github.com/sponsors/svrooij
[link_issues]: https://github.com/svrooij/sonos-api-docs/issues
[link_issues]: https://github.com/svrooij/sonos-api-docs/issues
4 changes: 0 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
blank_issues_enabled: false
contact_links:
- name: Sonos discourd
url: https://discord.gg/VMtG6Ft36J
about: For quick answers to your questions check out our community.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Please describe your pull request.
- [ ] Make sure you are requesting to **pull a topic/feature/bugfix branch** (right side). Don't request your main!
- [ ] Make sure you are making a pull request against the **main branch** (left side). Also you should start *your branch* off *svrooij/sonos-api-docs/main*.
- [ ] Check your code additions will fail neither code linting checks nor unit test. (mine sometimes also fail, will probably ignore the lint failures)
- [ ] If you changed the **documentation.json** be sure to also [regenerate](https://svrooij.io/sonos-api-docs/developers.html#regenerate-documentation) the services files.
- [ ] If you changed the **documentation.json** be sure to also [regenerate](https://sonos.svrooij.io/developers.html#regenerate-documentation) the services files.
- [ ] The `docs/services/index.md` and the `docs/services/*.md` files should not be manually changed, only with the generator.

💔 Thank you!
2 changes: 1 addition & 1 deletion .github/workflows/generator.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node: [14, 16]
node: [16, 18]
defaults:
run:
working-directory: generator/sonos-docs
Expand Down
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
[![Sonos2mqtt][badge_sonos-mqtt]][link_sonos-mqtt]
[![Sonos cli][badge_sonos-cli]][link_sonos-cli]
[![Sonos typescript this library][badge_sonos-typescript]][link_sonos-typescript]
[![Join us on Discord][badge_discord]][link_discord]

[![Support me on Github][badge_sponsor]][link_sponsor]
[![Follow on Twitter][badge_twitter]][link_twitter]
Expand All @@ -16,11 +15,11 @@ This library is in no way connected to [Sonos](//en.wikipedia.org/wiki/Sonos). I

## Documentation

Check-out the (generated) documentation about all the SONOS UPNP services [svrooij.io/sonos-api-docs/services/](https://svrooij.io/sonos-api-docs/services/)
Check-out the (generated) documentation about all the SONOS UPNP services [svrooij.io/sonos-api-docs/services/](https://sonos.svrooij.io/services/)

[![Sonos api documentation][badge_sonos-docs]][link_sonos-docs]

[Read documentation](https://svrooij.io/sonos-api-docs)
[Read documentation](https://sonos.svrooij.io/)

### Manually documented

Expand All @@ -46,12 +45,6 @@ You can use the generator to generate your own discovery files, but we also have

These files together with the documentation file, are combined to a extensive JSON file, that is used as an input for the generator.

## Community

[![Join us on Discord][badge_discord]][link_discord]

If you need help building an app that talks to your sonos speakers, or you want to share some of your findings. [Join us on Discord][link_discord].

## Contributors ✨

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
Expand Down Expand Up @@ -80,7 +73,6 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!

[badge_discord]: https://img.shields.io/discord/782374564054564875?style=for-the-badge
[badge_issues]: https://img.shields.io/github/issues/svrooij/sonos-api-docs?style=for-the-badge
[badge_sonos-cli]: https://img.shields.io/badge/sonos-cli-blue?style=for-the-badge
[badge_sonos-docs]: https://img.shields.io/badge/sonos-api-blue?style=for-the-badge
Expand All @@ -89,11 +81,11 @@ specification. Contributions of any kind welcome!
[badge_sponsor]: https://img.shields.io/github/sponsors/svrooij?logo=github&style=for-the-badge
[badge_twitter]: https://img.shields.io/twitter/follow/svrooij?logo=twitter&style=for-the-badge

[link_discord]: https://discord.gg/ZUdEuhh5RF

[link_sponsor]: https://github.com/sponsors/svrooij
[link_issues]: https://github.com/svrooij/sonos-api-docs/issues
[link_sonos-cli]: https://github.com/svrooij/sonos-cli
[link_sonos-docs]: https://svrooij.io/sonos-api-docs
[link_sonos-mqtt]: https://svrooij.io/sonos2mqtt
[link_sonos-typescript]: https://svrooij.io/node-sonos-ts
[link_sonos-docs]: https://sonos.svrooij.io/
[link_sonos-mqtt]: https://sonos2mqtt.svrooij.io/
[link_sonos-typescript]: https://sonos-ts.svrooij.io/
[link_twitter]: https://twitter.com/svrooij
Loading

0 comments on commit cff07fb

Please sign in to comment.