Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md: Clarify manual installation instructions #587

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md: Clarify manual installation instructions #587

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,23 +77,31 @@ This card is available in [HACS](https://hacs.xyz/) (Home Assistant Community St

### Manual install

1. Download and copy `apexcharts-card.js` from the [latest release](https://github.com/RomRider/apexcharts-card/releases/latest) into your `config/www` directory.
1. Download and copy `apexcharts-card.js` from the [latest release](https://github.com/RomRider/apexcharts-card/releases/latest) into your `"config"/www` directory.

2. Add the resource reference as decribed below.

### CLI install
#### CLI install

1. Move into your `config/www` directory.

2. Grab `apexcharts-card.js`:
1. Move into your "config" directory (where the `configuration.yaml` is)
```
cd $(dirname $(find / -name configuration.yaml 2>/dev/null))
```
2. Create and enter directory `www`
```
mkdir www; cd $_
```
3. Grab `apexcharts-card.js`:

```
$ wget https://github.com/RomRider/apexcharts-card/releases/download/v2.0.4/apexcharts-card.js
```

3. Add the resource reference as decribed below.

### Add resource reference
#### Add resource reference

##### Via Lovelace config

If you configure Lovelace via YAML, add a reference to `apexcharts-card.js` inside your `configuration.yaml`:

Expand All @@ -102,7 +110,7 @@ resources:
- url: /local/apexcharts-card.js?v=2.0.4
type: module
```

##### Via GUI
Else, if you prefer the graphical editor, use the menu to add the resource:

1. Make sure, advanced mode is enabled in your user profile (click on your user name to get there)
Expand Down Expand Up @@ -1064,4 +1072,4 @@ apex_config:
height: 250px
series:
- entity: sensor.temperature
```
```