X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=README.md;h=ff435ff198521c34be1c4c77f8ea3cd882ba7523;hb=58445d22c26c02e865f2d494de7255cc72cfa25d;hp=fbf1db500d8a85dbe655053d1f7daef276b50ffa;hpb=c4160f5b4aa1f891529790b9d6011039c96e24c2;p=awesomized%2Fext-ion diff --git a/README.md b/README.md index fbf1db5..ff435ff 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,50 @@ -# ext-ion +# pecl/ion +## About: PHP extension wrapping [amzn/ion-c](https://github.com/amzn/ion-c). See the [Amazon ION specification](https://amzn.github.io/ion-docs/). -## License +## License: [BSD-2-Clause](https://github.com/awesomized/ext-ion/blob/master/LICENSE); see [spdx.org](https://spdx.org/licenses/BSD-2-Clause.html). -## Install -### Dependencies -#### Required +## Installation: + +### Dependencies: +#### Required: * PHP-8.1 * ext/date (standard) * ext/spl (standard) -#### Optional +#### Optional: * [amzn/ion-c](https://github.com/amzn/ion-c) (bundled as git submodule) -### Trinity +### Trinity: ```shell phpize -./configure +./configure # --with-php-config= make # -j$(nproc) sudo make install # INSTALL=install ``` -### Try with Docker + +### PECL + + pecl install ion + +### PHARext + +Watch out for [PECL replicates](https://replicator.pharext.org?ion) +and pharext packages attached to [releases](./releases). + +### Try with Docker: ```shell docker build -t php-ion -docker run --rm php-ion -r 'echo ion\serialize(ion\Symbol\Table\PHP());' +docker run --rm php-ion -r 'echo ion\serialize(ion\Symbol\PHP::asTable());' ``` -### PECL -> WIP -### PHARext -> WIP -## IDE Stub +## Editor Stub: See [ion.stub.php](https://github.com/awesomized/ext-ion/blob/master/ion.stub.php). -## Known Issues +## Known Issues: Due to private internal state of ion-c's readers and writers, instances of the following PHP classes cannot be cloned: * ion\Reader\Reader