X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=README.md;h=78d216de17d795124c18a907e17d1a56e4fed110;hb=cc67a43993662a5a3f92801b96b89ee6e3998532;hp=b0d323b479edbe66b86b4571d87a12699190e158;hpb=b6bd997767fed557f15f052c9f188d54e8dc2656;p=plcapi.git diff --git a/README.md b/README.md index b0d323b..78d216d 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,32 @@ A php library for building xml-rpc clients and servers. Installation ------------ -Installation instructions are in the [INSTALL.md](INSTALL.md) file. +The recommended way to install this library is using Composer. -Docs ----- -The manual, in HTML and pdf versions, can be found in the doc/ directory. -Use of this software is subject to the terms in doc/index.html +Detailed installation instructions are in the [INSTALL.md](INSTALL.md) file, along with system requirements listing. + +Documentation +------------- +The user manual can be found in the doc/manual directory, in Asciidoc format: [phpxmlrpc_manual.adoc](doc/manual/phpxmlrpc_manual.adoc) + +Release tarballs also contain the HTML and PDF versions, as well as an automatically generated API documentation. + +Upgrading +--------- +If you are upgrading from version 3 or earlier, please read the docs in [doc/api_changes_v4.md](doc/api_changes_v4.md) + +License +------- +Use of this software is subject to the terms in the [license.txt](license.txt) file SSL-certificate --------------- The passphrase for the rsakey.pem certificate is 'test'. +[![License](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/license)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc) [![Latest Stable Version](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/v/stable)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc) [![Total Downloads](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/downloads)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc) -[![License](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/license)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc) [![Build Status](https://travis-ci.org/gggeek/phpxmlrpc.svg?branch=php53)](https://travis-ci.org/gggeek/phpxmlrpc) [![Test Coverage](https://codeclimate.com/github/gggeek/phpxmlrpc/badges/coverage.svg)](https://codeclimate.com/github/gggeek/phpxmlrpc)