Skip to content

Commit 815c0e2

Browse files
Update readme
1 parent e09d09e commit 815c0e2

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,20 @@
1313
PM> Install-Package TimeZoneConverter
1414
```
1515

16-
This library should be compatible with .NET Standard 1.1 and greater, as well as .NET Framework 3.5 and greater.
17-
See the [.NET Standard Platform Support Matrix][1] for further details about .NET Standard,
18-
and please raise an issue if you encounter any compatibility errors.
16+
As of version 4.0.0, *TimeZoneConverter* works with all of the following:
1917

20-
#### Important note on .NET 6+
18+
- .NET 5 or greater
19+
- .NET Core 2.0 or greater
20+
- .NET Framework 4.6.1 and greater
21+
22+
Note that .NET Framework versions less than 4.6.1 are no longer supported.
2123

22-
.NET 6 will have built-in support for IANA and Windows time zones in a cross-platform manner, removing the need for the TimeZoneConverter library.
23-
**If you are planning to use .NET 6 (or higher), you don't need to use the TimeZoneConverter library!**
24+
#### Important note on .NET 6+
2425

25-
Both automatic time zone conversion and APIs for manual time zone conversion are included with .NET as of .NET 6 Preview 4.
26-
You can read more about it in [the blog post here](https://devblogs.microsoft.com/dotnet/date-time-and-time-zone-enhancements-in-net-6/#time-zone-conversion-apis).
26+
.NET 6 has built-in support for IANA and Windows time zones in a cross-platform manner, removing the need for the TimeZoneConverter library.
27+
It relies on [.NET's ICU integration](https://docs.microsoft.com/dotnet/core/extensions/globalization-icu) to perform this functionality.
28+
See [the .NET blog](https://devblogs.microsoft.com/dotnet/date-time-and-time-zone-enhancements-in-net-6/#time-zone-conversion-apis) for details.
29+
**If you are targeting only .NET 6 (or higher), and you have either platform-provided or App-local ICU enabled, you don't need to use the TimeZoneConverter library!**
2730

2831
#### Note on OS Data Dependencies
2932

@@ -40,11 +43,17 @@ For example, the Alpine Linux Docker images for .NET Core no longer ship with `t
4043
PM> Install-Package TimeZoneConverter.Posix
4144
```
4245

43-
This library should be compatible with .NET Standard 1.3 and greater, as well as .NET Framework 4.5 and greater.
44-
See the [.NET Standard Platform Support Matrix][1] for further details about .NET Standard,
45-
and please raise an issue if you encounter any compatibility errors.
46+
This is a separate helper library that is maintained in the same repository. You only need it if you require support for POSIX time zones.
47+
48+
As of version 3.0.0, *TimeZoneConverter.Posix* works with all of the following:
49+
50+
- .NET 5 or greater
51+
- .NET Core 2.0 or greater
52+
- .NET Framework 4.6.1 and greater
53+
54+
Note that .NET Framework versions less than 4.6.1 are no longer supported.
4655

47-
Note that `TimeZoneConverter.Posix` takes a dependency on both `TimeZoneConverter` and [Noda Time][2].
56+
Also note that `TimeZoneConverter.Posix` takes a dependency on both `TimeZoneConverter` and [Noda Time][2].
4857

4958
## Notes
5059

@@ -90,8 +99,6 @@ string tz = TZConvert.WindowsToIana("Eastern Standard Time", "CA");
9099
```
91100

92101
Get a `TimeZoneInfo` object from .NET Core, regardless of what OS you are running on:
93-
*Helps with .NET Runtime issue [#18644][8]*
94-
***This function is only available for .NET Standard 1.3+ or full .NET Framework targets***
95102

96103
```csharp
97104
// Either of these will work on any platform:
@@ -155,15 +162,14 @@ string posix = PosixTimeZone.FromTimeZoneInfo(TimeZoneInfo.Local);
155162

156163
## License
157164

158-
This library is provided free of charge, under the terms of the [MIT license][9].
165+
This library is provided free of charge, under the terms of the [MIT license][8].
159166

160167

161168
[1]: https://docs.microsoft.com/en-us/dotnet/articles/standard/library
162169
[2]: https://nodatime.org
163-
[3]: http://cldr.unicode.org
170+
[3]: https://cldr.unicode.org
164171
[4]: https://iana.org/time-zones
165172
[5]: https://aka.ms/dstblog
166173
[6]: https://github.com/rails/rails/blob/master/activesupport/lib/active_support/values/time_zone.rb
167174
[7]: https://support.microsoft.com/en-us/help/4051956/time-zone-and-dst-changes-in-windows-for-northern-cyprus-sudan-and-ton
168-
[8]: https://github.com/dotnet/runtime/issues/18644
169-
[9]: https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/LICENSE.txt
175+
[8]: https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/LICENSE.txt

0 commit comments

Comments
 (0)