Skip to content

Commit a488bc2

Browse files
authored
Update README.md
1 parent 123ee78 commit a488bc2

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
# phonenumbers
1+
# ☎️ phonenumbers
22
[![Build Status](https://github.com/nyaruka/phonenumbers/workflows/CI/badge.svg)](https://github.com/nyaruka/phonenumbers/actions?query=workflow%3ACI)
33
[![codecov](https://codecov.io/gh/nyaruka/phonenumbers/branch/main/graph/badge.svg)](https://codecov.io/gh/nyaruka/phonenumbers)
44
[![GoDoc](https://godoc.org/github.com/nyaruka/phonenumbers?status.svg)](https://godoc.org/github.com/nyaruka/phonenumbers)
55

6-
golang port of Google's libphonenumber, forked from [libphonenumber from ttacon](https://github.com/ttacon/libphonenumber) which in turn is a port of the original [Java library](https://github.com/googlei18n/libphonenumber/tree/master/java/libphonenumber/src/com/google/i18n/phonenumbers).
6+
golang port of Google's [libphonenumber](https://github.com/googlei18n/libphonenumber) forked from libphonenumber from [ttacon/libphonenumber](https://github.com/ttacon/libphonenumber). This library is used daily in production for parsing and validation of numbers across the world, so is well maintained. Please open an issue if you encounter any problems, we'll do our best to address them.
77

8-
This fork fixes quite a few bugs and more closely follows the official Java implementation. It also adds the `buildmetadata` cmd to allow for rebuilding the metadata protocol buffers, country code to region maps and timezone prefix maps. We keep this library up to date with the upstream Google repo as metadata changes take place, usually no more than a few days behind official Google releases.
8+
> [!IMPORTANT]
9+
> The aim of this project is strictly to be a port and match as closely as possible the functionality in libphonenumber. Please don't submit feature requests for functionality that doesn't exist in libphonenumber.
910
10-
This library is used daily in production for parsing and validation of numbers across the world, so is well maintained. Please open an issue if you encounter any problems, we'll do our best to address them.
11+
> [!IMPORTANT]
12+
> We use the metadata from libphonenumber so if you encounter unexpected parsing results, please first verify if the problem affects libphonenumber and report there if so. You can use their [online demo](https://libphonenumber.appspot.com) to quickly check parsing results.
1113
12-
# Version Numbers
14+
## Version Numbers
1315

1416
As we don't want to bump our major semantic version number in step with the upstream library, we use independent version numbers than the Google libphonenumber repo. The release notes will mention what version of the metadata a release was built against.
1517

16-
# Usage
18+
## Usage
1719

1820
```go
1921
// parse our phone number
@@ -23,7 +25,7 @@ num, err := phonenumbers.Parse("6502530000", "US")
2325
formattedNum := phonenumbers.Format(num, phonenumbers.NATIONAL)
2426
```
2527

26-
# Rebuilding Metadata and Maps
28+
## Updating Metadata
2729

2830
The `buildmetadata` command will fetch the latest XML file from the official Google repo and rebuild the go source files
2931
containing all the territory metadata, timezone and region maps.

0 commit comments

Comments
 (0)