fix PHP5-ZTS

[m6w6/ext-apfd] / README.md

diff --git a/README.md b/README.md
index a00e8c8d1b8103e44c20ef476171db3bad4dc015..2e1d469a8475f4b7a126b7114b78065eb647da1a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,47 @@
-# PECL :: apfd
+# ext-apfd
+
+[![Build Status](https://github.com/m6w6/ext-apfd/workflows/ci/badge.svg?branch=master)](https://github.com/m6w6/ext-apfd/actions?query=branch%3Amaster+workflow%3Aci)
+[![codecov](https://codecov.io/gh/m6w6/ext-apfd/branch/master/graph/badge.svg?token=Nku9tz8EMj)](https://codecov.io/gh/m6w6/ext-apfd)
 
 Always Populate Form Data
 
-## About
+## Documentation
+
+See the [online markdown reference](https://mdref.m6w6.name/apfd).
+
+## Install
+
+### PECL
+
+       pecl install apfd
+
+### PHARext
+
+Watch out for [PECL replicates](https://replicator.pharext.org?apfd)
+and pharext packages attached to [releases](https://github.com/m6w6/ext-apfd/releases).
+
+### Checkout
+
+       git clone github.com:m6w6/ext-apfd
+       cd ext-apfd
+       /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=apfd).
+
+## License
+
+ext-apfd is licensed under the 2-Clause-BSD license, which can be found in
+the accompanying [LICENSE](./LICENSE) file.
+
+## Contributing
 
-This tiny extension lets PHP's post handler parse multipart/form-data and
-application/x-www-form-urlencoded (or any other customly registered form data
-handler, like [json_post](http://github.com/php/pecl-http-json_post)) without
-regard to the request's request method.
+All forms of contribution are welcome! Please see the bundled
+[CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
 
-This extension does not provide any INI entries, constants, functions or classes.
+The list of past and current contributors is maintained in [THANKS](./THANKS).