X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=README.md;h=63cece5688bbbbdb80613c5b2402ea9ab8eb6e38;hb=1ec91b278afce996d10a54507239def43324cbd7;hp=a75235b3649f2979edb9dc90767efe09a6204b3b;hpb=bed57b3c24a75c182af4cff2aa17d840e4c2fe27;p=plcapi.git

diff --git a/README.md b/README.md
index a75235b..63cece5 100644
--- a/README.md
+++ b/README.md
@@ -10,9 +10,28 @@ Detailed installation instructions are in the [INSTALL.md](INSTALL.md) file, alo
 
 Documentation
 -------------
+
+See the documentation page at [gggeek.github.io/phpxmlrpc](https://gggeek.github.io/phpxmlrpc) for a list of the
+library main features and all project related information.
+
 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.
+Release tarballs also contain HTML and PDF versions of the manual, as well as an automatically generated API documentation.
+
+*NB: the user manual has not been updated yet with all the changes made in version 4. Please consider it unreliable!*
+
+*You are encouraged to look instead the code examples found in the demo/ directory*
+
+Upgrading
+---------
+If you are upgrading from version 3 or earlier you have two options:
+
+1. adapt your code to the new API (all changes needed are described in [doc/api_changes_v4.md](doc/api_changes_v4.md))
+
+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)
+
+In any case, read carefully the docs in [doc/api_changes_v4.md](doc/api_changes_v4.md) and report back any undocumented
+issue using GitHub.
 
 License
 -------
@@ -27,6 +46,6 @@ The passphrase for the rsakey.pem certificate is 'test'.
 [![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)
+[![Build Status](https://travis-ci.com/gggeek/phpxmlrpc.svg)](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)