# pecl/pq
-[![Build Status](https://travis-ci.org/m6w6/ext-pq.svg?branch=phpng)](https://travis-ci.org/m6w6/ext-pq)
+[![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)
+[![codecov](https://codecov.io/gh/m6w6/ext-pq/branch/master/graph/badge.svg?token=Nku9tz8EMj)](https://codecov.io/gh/m6w6/ext-pq)
## About:
### Highlights:
-* Nearly 100% support for [asynchronous usage](https://mdref.m6w6.name/pq/Connection/: Asynchronous Usage).
-* Extended [type support by pg_type](https://mdref.m6w6.name/pq/Types/: Overview).
+* Nearly 100% support for [asynchronous usage](https://mdref.m6w6.name/pq/Connection/:%20Asynchronous%20Usage).
+* Extended [type support by pg_type](https://mdref.m6w6.name/pq/Types/:%20Overview).
* Fetching simple [multi-dimensional array maps](https://mdref.m6w6.name/pq/Result/map).
* Working [Gateway implementation](https://github.com/m6w6/pq-gateway).
-## Installation:
+## Documentation
-This extension is hosted at [PECL](http://pecl.php.net) and can be installed with [PEAR](http://pear.php.net)'s pecl command:
+See the [online markdown reference](https://mdref.m6w6.name/pq).
- # pecl install pq
+Known issues are listed in [BUGS](./BUGS) and future ideas can be found in [TODO](./TODO).
-Also, watch out for self-installing [pharext](https://github.com/m6w6/pharext) packages attached to [releases](https://github.com/m6w6/ext-pq/releases).
+## Install
+
+### PECL
+
+ pecl install pq
+
+### PHARext
+
+Watch out for [PECL replicates](https://replicator.pharext.org?pq)
+and pharext packages attached to [releases](https://github.com/m6w6/ext-pq/releases).
+
+### Checkout
+
+ git clone github.com:m6w6/ext-pq
+ cd ext-pq
+ /path/to/phpize
+ ./configure --with-php-config=/path/to/php-config
+ make
+ sudo make install
## Dependencies:
* [json](http://php.net/json)
+## ChangeLog
+
+A comprehensive list of changes can be obtained from the
+[PECL website](https://pecl.php.net/package-changelog.php?package=pq).
+
+## License
+
+ext-pq is licensed under the 2-Clause-BSD license, which can be found in
+the accompanying [LICENSE](./LICENSE) file.
+
+## Contributing
-## Documentation:
+All forms of contribution are welcome! Please see the bundled
+[CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
-Documentation is available at https://mdref.m6w6.name/pq
+The list of past and current contributors is maintained in [THANKS](./THANKS).