docs

NEWS.md

@@ -1,13 +1,17 @@
-## XML-RPC for PHP EXTRAS version XXX - unreleased
+## XML-RPC for PHP EXTRAS version 1.0-beta3 - 2024/4/15
 
 - bumped the minimum required version of php to 5.4
 
 - bumped the minimum required version of phpxmlrpc/phpxmlrpc to 4.10
 
+- run CI tests also on php 8.3
+
+
 ## XML-RPC for PHP EXTRAS version 1.0-beta2 - 2023/1/19
 
 - improved integration of ServerDocumentor with recent jsxmlrpc lib versions
 
+
 ## XML-RPC for PHP EXTRAS version 1.0-beta1 - 2023/1/19
 
 - bumped the minimum required version of the base phpxmlrpc library to 4.6
@@ -21,6 +25,7 @@
 - converted the remaining source/docs files to utf8
 - moved from Travis to GitHub Actions for testing; test on all php versions from 5.4 to 8.2
 
+
 ## XML-RPC for PHP EXTRAS version 1.0-alpha - 2021/1/3
 
 Major changes this time around!

README.md

@@ -4,14 +4,17 @@ PHPXMLRPC Extras
 ## DESCRIPTION
   A collection of server addons that might be of use for development of xml-rpc (and json-rpc) based applications
 
+
 ## REQUIREMENTS
 
-  * PHP 5.3 or newer
-  * phpxmlrpc/phpxmlrpc 4.6.0 or newer
+  * PHP 5.4 or newer
+  * phpxmlrpc/phpxmlrpc 4.10.0 or newer
+
 
 ## API DOCUMENTATION
   documentation can be found in the doc/ directory. _NB_ the docbook manual is quite outdated.
 
+
 ## COPYRIGHT:
   Use of this software is subject to the terms in [license.txt](license.txt)
 
@@ -29,6 +32,28 @@ PHPXMLRPC Extras
   Subclass of the xml-rpc server that can act as remote (transparent) xml-rpc proxy to forward calls to a remote server.
   Can either forward any received call or probe remote server first for existing methods.
 
+
+## Running tests
+
+The recommended way to run the library test suite is via the provided Docker containers.
+A handy shell script is available that simplifies usage of Docker.
+
+The full sequence of operations is:
+
+    ./tests/ci/vm.sh build
+    ./tests/ci/vm.sh start
+    ./tests/ci/vm.sh runtests
+    ./tests/ci/vm.sh stop
+
+    # and, once you have finished all testing related work:
+    ./tests/ci/vm.sh cleanup
+
+By default, tests are run using php 7.4 in a Container based on Ubuntu 20 Focal.
+You can change the version of PHP and Ubuntu in use by setting the environment variables PHP_VERSION and UBUNTU_VERSION
+before building the Container.
+
+To generate the code-coverage report, run `./tests/ci/vm.sh runcoverage`
+
 [![License](https://poser.pugx.org/phpxmlrpc/extras/license)](https://packagist.org/packages/phpxmlrpc/extras)
 [![Latest Stable Version](https://poser.pugx.org/phpxmlrpc/extras/v/stable)](https://packagist.org/packages/phpxmlrpc/extras)
 [![Total Downloads](https://poser.pugx.org/phpxmlrpc/extras/downloads)](https://packagist.org/packages/phpxmlrpc/extras)