X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-pq;a=blobdiff_plain;f=README.md;h=38da65b9bed83f8350e1acee6728cb8498d15dd0;hp=e251e3792518a45366814c795b70075fa923a8ce;hb=e29dd4bc37c32a59ee5f19ec46d767d7ec44899e;hpb=3c7eea4bb454d4b40b3e59351bf8ef96808c9605

diff --git a/README.md b/README.md
index e251e37..38da65b 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,71 @@
-pecl/pq
-=======
+# pecl/pq
 
-[![Build Status](https://travis-ci.org/php/pecl-database-pq.svg?branch=master)](https://travis-ci.org/php/pecl-database-pq)
+[![Build Status](https://travis-ci.org/m6w6/ext-pq.svg?branch=v1.0.x)](https://travis-ci.org/m6w6/ext-pq)
 
-About
------
+## About:
 
 This is a modern binding to the mature [libpq](http://www.postgresql.org/docs/current/static/libpq.html), the official PostgreSQL C-client library.
 
-Highlights:
+### Highlights:
 
-- Nearly 100% support for asynchronous usage.
-- Extended type support by pg_type.
-- Fetching simple multi-dimensional array maps.
-- Working [Gateway implementation](https://github.com/m6w6/pq-gateway).
+* 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).
+* 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).
 
-Dependencies
-------------
+## 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:
 
 This extension unconditionally depends on the pre-loaded presence of the following PHP extensions:
 
 - [raphf](http://pecl.php.net/package/raphf)
 - [spl](http://php.net/spl)
 
-Documentation
--------------
+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
+
+All forms of contribution are welcome! Please see the bundled
+[CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
 
-Documentation is available [here](http://devel-m6w6.rhcloud.com/mdref/pq).
+The list of past and current contributors is maintained in [THANKS](./THANKS).