Skip to content

Commit bad315e

Browse files
authored
Improve and simplify installation docs
1 parent 83918f5 commit bad315e

File tree

1 file changed

+20
-45
lines changed

1 file changed

+20
-45
lines changed

README.md

Lines changed: 20 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,22 @@ Inspired by [Custom UI: Mini media player](https://community.home-assistant.io/t
1010
![Preview Image](https://user-images.githubusercontent.com/457678/47517460-9282d600-d888-11e8-9705-cf9ec3698c3c.png)
1111

1212

13-
## Install
13+
## Installation
1414

15-
*This card is available in [HACS](https://github.com/hacs/integration) (Home Assistant Community Store)*
15+
### HACS (recommended)
1616

17-
### Simple install
17+
This card is available in [HACS](https://github.com/hacs/integration) (Home Assistant Community Store).
18+
19+
1. Install HACS if you don't have it already
20+
2. Open HACS in Home Assistant
21+
3. Go to "Frontend" section
22+
4. Click button with "+" icon
23+
5. Search for "Mini Media Player"
24+
25+
### Manual install
26+
27+
#### UI mode
1828

19-
#### Storage mode **(default)**
2029
1. Download and copy `mini-media-player-bundle.js` from the [latest release](https://github.com/kalkih/mini-media-player/releases/latest) into your `config/www` directory.
2130
2. Go to Sidebar -> Settings -> Dashboards -> Menu (top right corner) -> Resources.
2231
3. Click on `+ ADD RESOURCE`.
@@ -27,50 +36,16 @@ Inspired by [Custom UI: Mini media player](https://community.home-assistant.io/t
2736
#### YAML mode
2837

2938
1. Download and copy `mini-media-player-bundle.js` from the [latest release](https://github.com/kalkih/mini-media-player/releases/latest) into your `config/www` directory.
30-
3139
2. Add a reference to `mini-media-player-bundle.js` inside your `configuration.yaml` or through the Home Assistant UI from the resource tab.
3240

33-
```yaml
34-
lovelace:
35-
resources:
36-
- url: /local/mini-media-player-bundle.js?v=1.16.8
37-
type: module
38-
```
39-
40-
### CLI install
41-
42-
1. Move into your `config/www` directory
43-
44-
2. Grab `mini-media-player-bundle.js`
45-
46-
```console
47-
$ wget https://github.com/kalkih/mini-media-player/releases/download/v1.16.8/mini-media-player-bundle.js
48-
```
49-
50-
3. Add a reference to `mini-media-player-bundle.js` inside your `configuration.yaml` or through the Home Assistant UI from the resource tab.
51-
52-
```yaml
53-
lovelace:
54-
resources:
55-
- url: /local/mini-media-player-bundle.js?v=1.16.8
56-
type: module
57-
```
58-
59-
## Updating
60-
1. Find your `mini-media-player-bundle.js` file in `config/www` or wherever you ended up storing it.
61-
62-
2. Replace the local file with the latest one attached in the [latest release](https://github.com/kalkih/mini-media-player/releases/latest).
63-
64-
3. Add the new version number to the end of the cards reference url in your `configuration.yaml` (YAML mode) or through the Home Assistant UI - `Sidebar -> Settings -> Dashboards -> Menu (top right corner) -> Resources` (Storage mode).
65-
66-
```yaml
67-
lovelace:
68-
resources:
69-
- url: /local/mini-media-player-bundle.js?v=1.16.8
70-
type: module
71-
```
41+
```yaml
42+
lovelace:
43+
resources:
44+
- url: /local/mini-media-player-bundle.js?v=1.16.8
45+
type: module
46+
```
7247
73-
*You may need to empty the browsers cache if you have problems loading the updated card.*
48+
*To update the card to a new version after manual installation, update `mini-media-player-bundle.js` file from [latest release](https://github.com/kalkih/mini-media-player/releases/latest) and edit version of the card in your resources. You may need to empty the browsers cache if you have problems loading the updated card.*
7449

7550
## Using the card
7651

0 commit comments

Comments
 (0)