X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-json_post;a=blobdiff_plain;f=README.md;h=689ee8c2a49c56c636f310c51cf867eab9abc072;hp=cc8b8acae2ed22c6745287a137b8f1bac1877636;hb=b854e23a2a2399fb034f3133805b08756569a22b;hpb=bc3829fecbd951613c960230cd08ffe59fcab42c diff --git a/README.md b/README.md index cc8b8ac..689ee8c 100644 --- 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](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 -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).