X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-pq;a=blobdiff_plain;f=README.md;h=4c4a52c4a513b6e3fcc69a1d090aa1b7ea6a89fd;hp=a62b85d44667e044a1127b8ced97667fa191f773;hb=7910a40d7768bdfcf92a6fb8d194a52518cd7c5e;hpb=e125f60f2ca9863a2ad5eb2d5e615fab421c31e4 diff --git a/README.md b/README.md index a62b85d..4c4a52c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # pecl/pq -[![Build Status](https://travis-ci.org/m6w6/ext-pq.svg?branch=v1.0.x)](https://travis-ci.org/m6w6/ext-pq) +[![Build Status](https://travis-ci.org/m6w6/ext-pq.svg?branch=master)](https://travis-ci.org/m6w6/ext-pq) ## About: @@ -13,13 +13,34 @@ This is a modern binding to the mature [libpq](http://www.postgresql.org/docs/cu * 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). +## Installing + +### PECL + + pecl install pq + +Watch out for [PECL replicates](https://replicator.pharext.org?pq) +and pharext packages attached to [releases](./releases). + +### PHARext + +Watch out for [PECL replicates](https://replicator.pharext.org?pq) +and pharext packages attached to [releases](./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: @@ -32,7 +53,19 @@ It optionally depends on the following extensions: * [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).