Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
punxaphil committed Feb 7, 2024
1 parent a9d3080 commit 5d76baf
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 32 deletions.
2 changes: 1 addition & 1 deletion .release-notes-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
}
],
"template": "${{CHANGELOG}}",
"pr_template": "- [${{TITLE}}](https://github.com/johanfrick/custom-sonos-card/commit/${{MERGE_SHA}})",
"pr_template": "- [${{TITLE}}](https://github.com/punxaphil/custom-sonos-card/commit/${{MERGE_SHA}})",
"empty_template": "- no changes",
"label_extractor": [
{
Expand Down
50 changes: 19 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Media player card for Sonos speakers!
* Group/Ungroup speakers
* Control multiple speaker
* Play favorites from list
* Media browser
* Media browser button
* Control individual volumes in a group
* Artwork background
* Possibility to override artwork
Expand All @@ -19,11 +19,11 @@ Media player card for Sonos speakers!

and more!

![player.png](https://github.com/johanfrick/custom-sonos-card/raw/master/img/player.png)
![media_browser.png](https://github.com/johanfrick/custom-sonos-card/raw/master/img/media_browser.png)
![groups.png](https://github.com/johanfrick/custom-sonos-card/raw/master/img/groups.png)
![grouping.png](https://github.com/johanfrick/custom-sonos-card/raw/master/img/grouping.png)
![volumes.png](https://github.com/johanfrick/custom-sonos-card/raw/master/img/volumes.png)
![player.png](https://github.com/punxaphil/custom-sonos-card/raw/master/img/player.png)
![media_browser.png](https://github.com/punxaphil/custom-sonos-card/raw/master/img/media_browser.png)
![groups.png](https://github.com/punxaphil/custom-sonos-card/raw/master/img/groups.png)
![grouping.png](https://github.com/punxaphil/custom-sonos-card/raw/master/img/grouping.png)
![volumes.png](https://github.com/punxaphil/custom-sonos-card/raw/master/img/volumes.png)

## Support the project

Expand All @@ -35,7 +35,7 @@ Do you like the Sonos Card? Support the project with a coffee ☕️

### HACS

This card is available in HACS (Home Assistant Community Store)
Recommended way of installing this card is with HACS (Home Assistant Community Store).

### Manual

Expand All @@ -53,10 +53,10 @@ resources:
### Individual sections
By default, all sections of the card is available and you can jump between them in the footer of the card.
By default, all sections of the card is available, and you can jump between them in the footer of the card.
However, you can also select individual sections to enable. Use this if you want to show the different sections next to
each (by adding multiple instances of the card with different sections enabled).
each other (by adding multiple instances of the card with different sections enabled).
By using the section configuration you can utilise the full power of Home Assistant's layout capabilities and also drag
in other cards in your Sonos Dashboard view.
Expand Down Expand Up @@ -145,8 +145,8 @@ entitiesToIgnoreVolumeLevelFor: # default is empty. Use this if you want to igno
- media_player.my_sonos_port_device

# media browser specific
mediaBrowserItemsPerRow: 4 # default is 1. Use this to show items as icons.
mediaBrowserShowTitleForThumbnailIcons: true # default is false. Only makes a difference if mediaBrowserItemsPerRow > 1. Will show title for thumbnail artworks.
mediaBrowserItemsPerRow: 1 # default is 4. Use this to show items as list.
mediaBrowserHideTitleForThumbnailIcons: true # default is false. Only makes a difference if mediaBrowserItemsPerRow > 1. Will hide title for thumbnail artworks.
customThumbnail:
Voyage: https://i.scdn.co/image/ab67706f000000027b2e7ee752dc222ff2fd466f
customThumbnailIfMissing:
Expand All @@ -171,32 +171,20 @@ As mentioned earlier, use the individual sections for more layout flexibility.
Here is an example:
![sections.png](https://github.com/johanfrick/custom-sonos-card/raw/master/img/sections.png)
![sections.png](https://github.com/punxaphil/custom-sonos-card/raw/master/img/sections.png)
```yaml
type: horizontal-stack
cards:
- type: custom:sonos-card
sections:
- groups
- grouping
- volumes
widthPercentage: 100
- type: vertical-stack
cards:
- type: entities
entities:
- type: button
tap_action:
action: navigate
navigation_path: /
icon: mdi:arrow-left-circle
name: Back to home
- type: custom:sonos-card
sections:
- player
- type: custom:sonos-card
sections:
- player
- type: custom:sonos-card
sections:
- grouping
- media browser
```
Expand All @@ -215,7 +203,7 @@ Read more about using theme variables here: https://www.home-assistant.io/integr

## CSS Styling

The recommend way to change look and feel is to use the built in theming capabilities in Home Assistant. If that is not enough this card supports being styled with [card_mod](https://github.com/thomasloven/lovelace-card-mod).
The recommend way to change look and feel is to use the built-in theming capabilities in Home Assistant. If that is not enough this card supports being styled with [card_mod](https://github.com/thomasloven/lovelace-card-mod).

Example:

Expand All @@ -235,15 +223,15 @@ card_mod:
The above YAML renders the following:
![styling.png](https://github.com/johanfrick/custom-sonos-card/raw/master/img/styling.png)
![styling.png](https://github.com/punxaphil/custom-sonos-card/raw/master/img/styling.png)
## Dynamic volume level slider
The volume level slider is dynamically adjusting its scale. If volume is below 20% it will show a scale up to 30%. Above
20% it will show a scale up to 100%. The color will also change from green to red clearly indicating which scale is
being used.
![dynamic_volumes.png](https://github.com/johanfrick/custom-sonos-card/raw/master/img/dynamic_volumes.png)
![dynamic_volumes.png](https://github.com/punxaphil/custom-sonos-card/raw/master/img/dynamic_volumes.png)
Enable it in config with `dynamicVolumeSlider: true`

Expand Down
Binary file modified img/dynamic_volumes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/grouping.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/groups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/media_browser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/player.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/sections.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/volumes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5d76baf

Please sign in to comment.