X-Git-Url: http://git.onelab.eu/?p=plcapi.git;a=blobdiff_plain;f=README.md;h=78d216de17d795124c18a907e17d1a56e4fed110;hp=27d81e38b49dfc5259533ea77dfa912c8426275d;hb=19b99735570521d8172f73124ade5997b9dca75d;hpb=176750b0a4a054a8cad058df8cc8336221b3bf83 diff --git a/README.md b/README.md index 27d81e3..78d216d 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,36 @@ -[![Build Status](https://travis-ci.org/gggeek/phpxmlrpc.svg?branch=php53)](https://travis-ci.org/gggeek/phpxmlrpc) - XMLRPC for PHP ============== -A php library for building xmlrpc clients and servers. +A php library for building xml-rpc clients and servers. Installation ------------ -Installation instructions are in the INSTALL file. +The recommended way to install this library is using Composer. + +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. -Docs ----- -The manual, in HTML and pdf versions, can be found in the doc/ directory. -Recent changes in the ChangeLog file. -Use of this software is subject to the terms in doc/index.html +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) + +[![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) +[![Code Coverage](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc/badges/coverage.png?b=php53)](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc/?branch=php53)