X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-json_post;a=blobdiff_plain;f=README.md;h=bb0304aed02786614fab169bc80256426384f0fb;hp=c495e35973719d8826d5e5b8a3fa28a8f24cf561;hb=c1b0270e93fc2706027296233553933d03d3fd1e;hpb=5c72938056611ccba2a36bc2332e21c69855ae96 diff --git a/README.md b/README.md index c495e35..bb0304a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,47 @@ -# PECL :: json_post +# ext-json_post -JSON POST handler +[![Build Status](https://github.com/m6w6/ext-json_post/workflows/ci/badge.svg?branch=master)](https://github.com/m6w6/ext-json_post/actions?query=branch%3Amaster+workflow%3Aci) +[![codecov](https://codecov.io/gh/m6w6/ext-json_post/branch/master/graph/badge.svg?token=Nku9tz8EMj)](https://codecov.io/gh/m6w6/ext-json_post) -## About +JSON POST handler -This tiny extension provides a PHP content type handler for "text/json" to PHP's -form data parser. If the `Content-Type` of an incoming request is `text/json`, -the JSON contents of the request body will by parsed into `$_POST`. +## Documentation -This extension does not provide any constants, functions or classes. +See the [online markdown reference](https://mdref.m6w6.name/json_post). -### INI Entries +## Install -* `json_post.flags = 1` - Takes any combination of JSON_ flags which will be passed to `json_decode()`. - The default is `JSON_OBJECT_AS_ARRAY`. +### PECL + + pecl install json_post + +### PHARext + +Watch out for [PECL replicates](https://replicator.pharext.org?json_post) +and pharext packages attached to [releases](https://github.com/m6w6/ext-json_post/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 + +ext-json_post 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).