fixup #42
[m6w6/ext-pq] / README.md
1 # pecl/pq
2
3 [![Build Status](https://github.com/m6w6/ext-pq/workflows/ci/badge.svg?branch=master)](https://github.com/m6w6/ext-pq/actions?query=branch%3Amaster+workflow%3Aci)
4 [![codecov](https://codecov.io/gh/m6w6/ext-pq/branch/master/graph/badge.svg?token=Nku9tz8EMj)](https://codecov.io/gh/m6w6/ext-pq)
5
6 ## About:
7
8 This is a modern binding to the mature [libpq](http://www.postgresql.org/docs/current/static/libpq.html), the official PostgreSQL C-client library.
9
10 ### Highlights:
11
12 * Nearly 100% support for [asynchronous usage](https://mdref.m6w6.name/pq/Connection/:+Asynchronous+Usage).
13 * Extended [type support by pg_type](https://mdref.m6w6.name/pq/Types/:+Overview).
14 * Fetching simple [multi-dimensional array maps](https://mdref.m6w6.name/pq/Result/map).
15 * Working [Gateway implementation](https://github.com/m6w6/pq-gateway).
16
17 ## Documentation
18
19 See the [online markdown reference](https://mdref.m6w6.name/pq).
20
21 Known issues are listed in [BUGS](./BUGS) and future ideas can be found in [TODO](./TODO).
22
23 ## Install
24
25 ### PECL
26
27 pecl install pq
28
29 ### PHARext
30
31 Watch out for [PECL replicates](https://replicator.pharext.org?pq)
32 and pharext packages attached to [releases](https://github.com/m6w6/ext-pq/releases).
33
34 ### Checkout
35
36 git clone github.com:m6w6/ext-pq
37 cd ext-pq
38 /path/to/phpize
39 ./configure --with-php-config=/path/to/php-config
40 make
41 sudo make install
42
43 ## Dependencies:
44
45 This extension unconditionally depends on the pre-loaded presence of the following PHP extensions:
46
47 - [raphf](http://pecl.php.net/package/raphf)
48 - [spl](http://php.net/spl)
49
50 It optionally depends on the following extensions:
51
52 * [json](http://php.net/json)
53
54 ## ChangeLog
55
56 A comprehensive list of changes can be obtained from the
57 [PECL website](https://pecl.php.net/package-changelog.php?package=pq).
58
59 ## License
60
61 ext-pq is licensed under the 2-Clause-BSD license, which can be found in
62 the accompanying [LICENSE](./LICENSE) file.
63
64 ## Contributing
65
66 All forms of contribution are welcome! Please see the bundled
67 [CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
68
69 The list of past and current contributors is maintained in [THANKS](./THANKS).