From 59bd7ea73b55366b648b87b40dce89c3d124e5cb Mon Sep 17 00:00:00 2001 From: Patrick Kissling Date: Wed, 4 Oct 2023 09:16:11 +0200 Subject: [PATCH] Update breaking changes section in Readme --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5bb07216..da77da8a 100644 --- a/README.md +++ b/README.md @@ -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