Skip to content

Commit

Permalink
Docs: Improve README with latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
danimart1991 committed Dec 13, 2023
1 parent 4b691f2 commit a4851c2
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You could use [HACS](https://hacs.xyz/) or follow this [guide](https://www.danie

```yaml
resources:
url: /local/pvpc-hourly-pricing-card.js?v=1.9.0
url: /local/pvpc-hourly-pricing-card.js?v=1.12.0
type: module
```
Expand All @@ -43,11 +43,12 @@ resources:
| --- | --- | --- | --- | --- |
| type | string | `null` | **Required** | `custom:pvpc-hourly-pricing-card` |
| entity | string | `null` | **Required** | Spain electricity hourly pricing (PVPC) entity |
| name | string | `null` | Optional | Title of the card |
| current | boolean | `true` | Optional | Show the current price and pricing period |
| details | boolean | `true` | Optional | Show the lowest and highest prices and hours for the current and next day |
| graph | boolean | `true` | Optional | Show the graph with the prices for the current and next day |
| info | boolean | `true` | Optional | Show info like '*Tomorrow's data is no yet available*' |
| title | string | `null` | Optional | Title of the card |
| show_current | boolean | `true` | Optional | Show the current price and pricing period |
| show_details | boolean | `true` | Optional | Show the lowest and highest prices and hours for the current and next day |
| show_graph | boolean | `true` | Optional | Show the graph with the prices for the current and next day |
| show_info | boolean | `true` | Optional | Show info like '*Tomorrow's data is no yet available*' |
| graph_baseline_zero | boolean | `false` | Optional | Show graph with desired minimum line base zero. |

## Example

Expand All @@ -61,8 +62,8 @@ If this doesn't work, another option is to add it manually from your Lovelace Da

```yaml
type: custom:pvpc-hourly-pricing-card
name: "PVPC 2.0 DT"
entity: sensor.pvpc_2_0_dt
title: "PVPC Prices"
entity: sensor.pvpc
```

### Mode YAML
Expand All @@ -74,7 +75,7 @@ Add this lines of code to your Lovelace Dashboard YAML file:
cards:
...
- type: custom:pvpc-hourly-pricing-card
name: "PVPC 2.0 DT"
entity: sensor.pvpc_2_0_dt
title: "PVPC Prices"
entity: sensor.pvpc
...
```
Binary file modified docs/images/card-editor.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 docs/images/card-example.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 a4851c2

Please sign in to comment.