README.md

   1 XMLRPC for PHP
   2 ==============
   3 A php library for building xml-rpc clients and servers.
   4
   5 Installation
   6 ------------
   7 The recommended way to install this library is using Composer.
   8
   9 Detailed installation instructions are in the [INSTALL.md](INSTALL.md) file, along with system requirements listing.
  10
  11 Documentation
  12 -------------
  13
  14 *NB: the user manual has not been updated yet with all the changes made in version 4. Please consider it unreliable!*
  15
  16 *You are encouraged to look instead the code examples found in the demo/ directory*
  17
  18 The user manual can be found in the doc/manual directory, in Asciidoc format: [phpxmlrpc_manual.adoc](doc/manual/phpxmlrpc_manual.adoc)
  19
  20 Release tarballs also contain the HTML and PDF versions, as well as an automatically generated API documentation.
  21
  22 Upgrading
  23 ---------
  24 If you are upgrading from version 3 or earlier you have two options:
  25
  26 1. adapt your code to the new API (all changes needed are described in [doc/api_changes_v4.md](doc/api_changes_v4.md))
  27
  28 2. use instead the *compatibility layer* which is provided. Instructions and pitfalls described in [doc/api_changes_v4.md](doc/api_changes_v4.md##enabling-compatibility-with-legacy-code)
  29
  30 In any case, read carefully the docs in [doc/api_changes_v4.md](doc/api_changes_v4.md) and report back any undocumented
  31 issue using GitHub.
  32
  33 License
  34 -------
  35 Use of this software is subject to the terms in the [license.txt](license.txt) file
  36
  37 SSL-certificate
  38 ---------------
  39 The passphrase for the rsakey.pem certificate is 'test'.
  40
  41
  42 [![License](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/license)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc)
  43 [![Latest Stable Version](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/v/stable)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc)
  44 [![Total Downloads](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/downloads)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc)
  45
  46 [![Build Status](https://travis-ci.org/gggeek/phpxmlrpc.svg?branch=php53)](https://travis-ci.org/gggeek/phpxmlrpc)
  47 [![Test Coverage](https://codeclimate.com/github/gggeek/phpxmlrpc/badges/coverage.svg)](https://codeclimate.com/github/gggeek/phpxmlrpc)
  48 [![Code Coverage](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc/badges/coverage.png?b=php53)](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc/?branch=php53)