Skip to content

docs: Update README.md to provide reason why consumers should keep this nuget package up to date #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wmundev merged 2 commits into from
Feb 25, 2025
Merged

docs: Update README.md to provide reason why consumers should keep this nuget package up to date #286

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
351aa11
docs: Update README.md to provide reason why consumers should keep th…
wmundev Feb 24, 2025
9675f81
docs: Update README.md with link to google's faq
wmundev Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,15 @@ Console.WriteLine(regionCode); // US

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

## Why keep libphonenumber-csharp up to date?
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).

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

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.

For more information on metadata usage, please refer to the [main repository faq](https://github.com/google/libphonenumber/blob/master/FAQ.md#metadata)

## ToDo

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