standardization

[m6w6/ext-raphf] / README.md

diff --git a/README.md b/README.md
index 34f117ebcf965b6391ef26ac073f91df300a3e02..63b3f637ebb2330f7fec40f9b17301b8ee3c6147 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,29 +1,48 @@
-# pecl/raphf
+# ext-raphf
 
-## About:
+[![Build Status](https://travis-ci.org/m6w6/ext-raphf.svg?branch=v1.1.x)](https://travis-ci.org/m6w6/ext-raphf)
 
 The "Resource and Persistent Handle Factory" extension provides facilities to manage those in a convenient manner.
 
-## 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/raphf).
 
-    # pecl install raphf
+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-raphf/releases).
+## Installing
 
+### PECL
 
-## INI Directives:
+       pecl install raphf
 
-* raphf.persistent_handle.limit = -1  
-  The per process/thread persistent handle limit.
+### PHARext
 
-## Internals:
+Watch out for [PECL replicates](https://replicator.pharext.org?raphf)
+and pharext packages attached to [releases](./releases).
 
-> ***NOTE:***  
-  This extension mostly only provides infrastructure for other extensions.
-  See the [API docs here](http://m6w6.github.io/ext-raphf/).
+### Checkout
 
-## Documentation:
+       git clone github.com:m6w6/ext-raphf
+       cd ext-raphf
+       /path/to/phpize
+       ./configure --with-php-config=/path/to/php-config
+       make
+       sudo make install
 
-Userland documentation can be found at https://mdref.m6w6.name/raphf
+## ChangeLog
+
+A comprehensive list of changes can be obtained from the
+[PECL website](https://pecl.php.net/package-changelog.php?package=raphf).
+
+## License
+
+ext-raphf 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.
+
+The list of past and current contributors is maintained in [THANKS](./THANKS).