standards

[m6w6/ext-json_post] / README.md

diff --git a/README.md b/README.md
index cc8b8acae2ed22c6745287a137b8f1bac1877636..f1cd90e3e242c151ada9cc8acf8a2805d9f7735c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,46 @@
-# PECL :: json_post [![Build Status](https://travis-ci.org/m6w6/ext-json_post.svg?branch=master)](https://travis-ci.org/m6w6/ext-sjon_post)
+# ext-json_post
+
+[![Build Status](https://travis-ci.org/m6w6/ext-json_post.svg?branch=master)](https://travis-ci.org/m6w6/ext-json_post)
 
 JSON POST handler 
 
-## About
+## Documentation
+
+See the [online markdown reference](https://mdref.m6w6.name/json_post).
+
+## Installing
+
+### PECL
+
+       pecl install json_post
+
+### PHARext
+
+Watch out for [PECL replicates](https://replicator.pharext.org?json_post)
+and pharext packages attached to [releases](./releases).
+
+### Checkout
+
+       git clone github.com:m6w6/ext-json_post
+       cd ext-json_post
+       /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=json_post).
+
+## License
 
-This tiny extension provides a PHP content type handler for JSON to PHP's
-form data parser. If the `Content-Type` of an incoming request is `text/json`
-or `application/json`, the JSON contents of the request body will by parsed
-into `$_POST`.
+ext-json_post is licensed under the 2-Clause-BSD license, which can be found in
+the accompanying [LICENSE](./LICENSE) file.
 
-This extension does not provide any constants, functions or classes.
+## Contributing
 
-### INI Entries
+All forms of contribution are welcome! Please see the bundled
+[CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
 
-* `json_post.flags = 1`  
-  Takes any combination of JSON_ flags which will be passed to `json_decode()`.  
-  The default is `JSON_OBJECT_AS_ARRAY`.
+The list of past and current contributors is maintained in [THANKS](./THANKS).