standards

[m6w6/ext-propro] / README.md

diff --git a/README.md b/README.md
index b10e13ce59e713f7e7b3adeff94db6e3ea8cc9ee..333d2c1d5d77213b5d6fb25c674605980b673eac 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,23 +1,46 @@
-# pecl/propro
+# ext-propro
 
-## About:
+[![Build Status](https://travis-ci.org/m6w6/ext-propro.svg?branch=master)](https://travis-ci.org/m6w6/ext-propro)
 
-The "Property Proxy" extension provides a fairly transparent proxy for internal object properties hidden in custom non-zval implementations.
+Property Proxy
 
-## 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/propro).
 
-    # pecl install propro
+## Installing
 
-Also, watch out for self-installing [pharext](https://github.com/m6w6/pharext) packages attached to [releases](https://github.com/m6w6/ext-propro/releases).
+### PECL
 
-## Internals:
+       pecl install propro
 
-> ***NOTE:***
-  This extension mostly only provides infrastructure for other extensions.
-  See the [API docs here](http://m6w6.github.io/ext-propro/).
+### PHARext
 
-## Documentation
+Watch out for [PECL replicates](https://replicator.pharext.org?propro)
+and pharext packages attached to [releases](./releases).
+
+### Checkout
+
+       git clone github.com:m6w6/ext-propro
+       cd ext-propro
+       /path/to/phpize
+       ./configure --with-php-config=/path/to/php-config
+       make
+       sudo make install
+
+## ChangeLog
+
+A comprehensive list of changes can be obtained from the
+[PECL website](https://pecl.php.net/package-changelog.php?package=propro).
+
+## License
+
+ext-propro 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.
 
-Userland documentation can be found at https://mdref.m6w6.name/propro
+The list of past and current contributors is maintained in [THANKS](./THANKS).