From: Michael Wallner <mike@php.net>
Date: Fri, 7 Jan 2022 20:06:31 +0000 (+0100)
Subject: add README
X-Git-Tag: v0.1.0~43
X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=c4160f5b4aa1f891529790b9d6011039c96e24c2;p=awesomized%2Fext-ion

add README
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fbf1db5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# ext-ion
+
+PHP extension wrapping [amzn/ion-c](https://github.com/amzn/ion-c).
+See the [Amazon ION specification](https://amzn.github.io/ion-docs/).
+
+## 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
+* PHP-8.1
+  * ext/date (standard)
+  * ext/spl (standard)
+#### Optional
+* [amzn/ion-c](https://github.com/amzn/ion-c) (bundled as git submodule)
+
+### Trinity
+```shell
+phpize
+./configure
+make # -j$(nproc)
+sudo make install # INSTALL=install
+```
+### 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
+See [ion.stub.php](https://github.com/awesomized/ext-ion/blob/master/ion.stub.php).
+
+## 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
+* ion\Writer\Writer
+* ion\Serializer\PHP
+* ion\Unserializer\PHP