Skip to content

Commit c6bd5cc

Browse files
authored
docs: Update README.md to provide reason why consumers should keep this nuget package up to date (twcclegg#286)
* docs: Update README.md to provide reason why consumers should keep this nuget package up to date * docs: Update README.md with link to google's faq
1 parent db885c8 commit c6bd5cc

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,15 @@ Console.WriteLine(regionCode); // US
9797

9898
See [PhoneNumberUtil.cs](csharp/PhoneNumbers/PhoneNumberUtil.cs) for the various methods and properties available.
9999

100+
## Why keep libphonenumber-csharp up to date?
101+
A lot of the functionality depends on updated metadata that is published by the google repository, see example [here](https://github.com/google/libphonenumber/releases/tag/v8.13.55).
102+
103+
This means that if you don't keep the package up to date, methods like `IsValidNumber` will return false for newer numbers that rely on the updated metadata
104+
105+
Therefore, we recommend you keep this nuget package as up to date as possible using automated means (such as dependabot) as metadata changes published by the google repository is frequent, usually a few times a month.
106+
107+
For more information on metadata usage, please refer to the [main repository faq](https://github.com/google/libphonenumber/blob/master/FAQ.md#metadata)
108+
100109
## ToDo
101110

102111
* port read / write source xml data to binary for better performance and smaller .nupkg size (WIP)

0 commit comments

Comments
 (0)