From dd70d0e644dae68c4222b683c9b1f976cdfe81af Mon Sep 17 00:00:00 2001 From: gggeek Date: Tue, 23 Apr 2024 09:45:46 +0000 Subject: [PATCH] readme --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d2d9b04..92f2c5c 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,21 @@ A pure-php reimplementation of the API exposed by the native XML-RPC extension. Originally bundled as part of the [phpxmlrpc/extras](https://github.com/gggeek/phpxmlrpc-extras) package. +Installation and usage +---------------------- + +The recommended way to install this library is via usage of Composer: just add `"phpxmlrpc/polyfill-xmlrpc": "^1.0.0"` +to your Composer "require" section. + +Usage: once your autoload configuration is set up properly (which is normally taken care for you by Composer), you +can just use in your code all the functions described at https://www.php.net/manual/en/ref.xmlrpc.php + Known differences from the original extension --------------------------------------------- ### Work in Progress! -This library is not complete yet, and thus to be considered a Work in Progress. +This library is not _fully_ complete yet, but it should be good enough for most users. Main features missing are: - character set handling: at the moment only utf-8 and iso-8859-1 are supported; iso-8859-1 as default, and utf-8 via: @@ -32,14 +41,9 @@ This means that the following are _not_ goals of this package: Eg. whitespace and element indentation in the produced xml strings do differ - reproducing behaviour of the native extension which is clearly buggy - Eg. the native extension will produce invalid xmlrpc requests when specific values are passed to an + Eg. the native extension will produce invalid xmlrpc requests when some specific values are passed to an `xmlrpc_encode_request` call -Installation and usage ----------------------- - -The recommended way to install this library is via usage of Composer. - Running tests -------------