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