-# 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:
+
+[PECL](https://pecl.php.net) and [PHARext](https://pharext.org) is WIP.
+
+### 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
make # -j$(nproc)
sudo make install # INSTALL=install
```
-### Try with Docker
+### Try with Docker:
```shell
docker build -t php-ion
docker run --rm php-ion -r 'echo ion\serialize(ion\Symbol\Table\PHP());'
```
-### 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