Skip to content

Commit

Permalink
Update breaking changes section in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pkissling committed Oct 4, 2023
1 parent bc35ea9 commit 59bd7ea
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,11 @@ showing the current date, time and a weather forecast.

Credits go to [basmilius](https://github.com/basmilius) for the awesome [weather icons](https://github.com/basmilius/weather-icons).

## Migrating from v1 to v2
## Breaking changes when migrating from v1 to v2

### Breaking changes
* Configuration property `forecast_days` was renamed to `forecast_rows` to indicate that this attribute does not only work for daily, but also for hourly forecasts.
* `date-fns` has been replaced by `luxon` for date/time formatting. If you configure `date_pattern`, make sure to migrate your pattern to comply with [luxon](https://moment.github.io/luxon/#/formatting?id=table-of-tokens). Additionally, the weekday is now [_not_ hardcoded](https://github.com/pkissling/clock-weather-card/issues/89) anymore.
* Configuration property `use_browser_time` is now by default `false`, so by default the card will show the time of the current HA time zone.
* Configuration property `forecast_days` was renamed to `forecast_rows` to indicate that this property not only applies for daily, but also for hourly forecasts.
* `date-fns` library has been replaced in favor of `luxon` for date/time formatting. If you provide a custom `date_pattern`, make sure to migrate the pattern from `date-fns` tokens to the [luxon pattern](https://moment.github.io/luxon/#/formatting?id=table-of-tokens). Additionally, [_not_ hardcoded weekdays being prepended to the date](https://github.com/pkissling/clock-weather-card/issues/89) have been removed. If you still want the weekday to be prepended, you have to specify the following pattern: `ccc, DD`.
* Configuration property `use_browser_time` is now by [default](https://github.com/pkissling/clock-weather-card/issues/157) `false`, so by default the card will show the time of the current HA time zone.

## FAQ

Expand Down

0 comments on commit 59bd7ea

Please sign in to comment.