docs: Update README.md
This commit is contained in:
parent
a64ad9495d
commit
f84f7bb4b8
18
README.md
18
README.md
|
@ -5,12 +5,13 @@ A (partially implemented!) PostgreSQL extension that provides access to
|
|||
|
||||
## Project status
|
||||
|
||||
This extension is in an <strong>alpha</strong> state. It's not complete or
|
||||
tested enough for critical production deployments, but with a little help, we
|
||||
should be able to get it there.
|
||||
This extension is in an **alpha** state. It's not complete or tested enough for
|
||||
critical production deployments, but with a little help, we should be able to
|
||||
get it there.
|
||||
|
||||
## Synopsis
|
||||
|
||||
```sql
|
||||
CREATE EXTENSION pg_libphonenumber;
|
||||
SELECT parse_phone_number('03 7010 1234', 'AU');
|
||||
SELECT parse_phone_number('2819010011', 'US');
|
||||
|
@ -20,21 +21,26 @@ should be able to get it there.
|
|||
-- DO NOT RELY ON THIS
|
||||
-- may not always this work way with implicit cast.
|
||||
SELECT '2819010011'::phone_number; -- assumes US
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
### Debian/Ubuntu
|
||||
|
||||
First you need install `libphonenumber-dev` and the corresponding `postgresql-server-dev` package.
|
||||
First you'll need to install `libphonenumber-dev` and the corresponding
|
||||
`postgresql-server-dev` package.
|
||||
|
||||
```shell-script
|
||||
sudo apt-get install build-essential
|
||||
sudo apt-get install postgresql-server-dev-9.5
|
||||
sudo apt-get install libphonenumber-dev
|
||||
```
|
||||
|
||||
Then clone this repostiroy
|
||||
Then clone this repository and build.
|
||||
|
||||
cd /tmp
|
||||
```shell-script
|
||||
git clone https://github.com/blm768/pg-libphonenumber
|
||||
cd pg-libphonenumber
|
||||
make
|
||||
sudo make install
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue