update basic documentation to interfaces v2 and commons v3

Author: gregor-j

common.md

@@ -1,6 +1,3 @@
-**ATTENTION: THIS IS WORK IN PROGRESS AND NOT TO BE USED UNTIL THIS MESSAGE
- DISAPPEARS!**
-
 ## About PHP/SAP
 
 PHP/SAP defines a layer of abstraction between actual SAP remote function calls
@@ -9,11 +6,11 @@ PHP/SAP defines a layer of abstraction between actual SAP remote function calls
 
 [![PHP/SAP](res/php-sap.svg)](res/php-sap.svg)
 
-The [interfaces](interfaces) define a common denominator on how to configure a
+The interfaces define a common denominator on how to configure a
  connection to SAP, prepare a SAP remote function call, and invoke a SAP remote
  function call.
 
-The [common classes and exceptions](common) add logic that is not specific to
+The common classes and exceptions add logic that is not specific to
  the underlying PHP module.
 
 The module specific implementations contain code that is specific to [the
@@ -24,38 +21,56 @@ The module specific implementations contain code that is specific to [the
 Especially short explanation for people in a hurry.
 
 Use `composer require` to add PHP/SAP to your project. Depending on the
- [PHP module](php-modules) you need to require a certain PHP/SAP composer
- package.
+ [PHP module](php-modules) you need to require a certain PHP/SAP package.
 
- Module Author            | Module      | supported PHP versions | composer require
- ------------------------ | ----------- | ---------------------- | -------------------------
- [Eduard Koucky][koucky]  | `saprfc`    | PHP 4.x - 5.5.x        | `composer require php-sap/saprfc-koucky`
- [Piers Harding][harding] | `sapnwrfc`  | PHP 5.x                | `composer require php-sap/saprfc-harding`
- [Gregor Kralik][kralik]  | `sapnwrfc`  | PHP 7.x                | `composer require php-sap/saprfc-kralik`
+`composer require php-sap/saprfc-koucky`   
+or   
+`composer require php-sap/saprfc-harding`   
+or   
+`composer require php-sap/saprfc-kralik`
 
 ```php
 <?php
-use phpsap\saprfc\SapRfcConfigA;
-use phpsap\saprfc\SapRfcConnection;
-
-$result = (new SapRfcConnection(new SapRfcConfigA([
-  'ashost' => 'sap.example.com',
-  'sysnr' => '001',
-  'client' => '002',
-  'user' => 'username',
-  'passwd' => 'password'
-])))
-    ->prepareFunction('MY_COOL_SAP_REMOTE_FUNCTION')
-    ->setParam('INPUT_PARAM', 'some input value')
-    ->invoke();
+//Include the composer autoloader ...
+require_once 'vendor/autoload.php';
+//... and add the namespaces of the classes used.
+use phpsap\classes\Config\ConfigTypeA;
+use phpsap\DateTime\SapDateTime;
+use phpsap\saprfc\SapRfc;
+/**
+ * Create an instance of the SAP remote function using its
+ * name, input parameters, and connection configuration.
+ *
+ * The imaginary SAP remote function requires a
+ * date as input and will return a date as output.
+ *
+ * In this case the configuration array is defined manually.
+ */
+$result = (new SapRfc(
+  'MY_COOL_SAP_REMOTE_FUNCTION',
+  [
+      'IV_DATE' => (new DateTime('2019-12-31'))
+                   ->format(SapDateTime::SAP_DATE)
+  ],
+  new ConfigTypeA([
+      ConfigTypeA::JSON_ASHOST => 'sap.example.com',
+      ConfigTypeA::JSON_SYSNR  => '999',
+      ConfigTypeA::JSON_CLIENT => '001',
+      ConfigTypeA::JSON_USER   => 'username',
+      ConfigTypeA::JSON_PASSWD => 'password'
+  ])
+))->invoke();
+//The output array contains a DateTime object.
+echo $result['OV_DATE']->format('Y-m-d') . PHP_EOL;
 ```
- 
+
+Too short? Confused? You should probably read the documentation. 😉
+
 ## Documentation
 
 * [Usage overview](usage)
     - [Configure a connection](saprfc-config)
-    - [Establish a connection](saprfc-connection)
-    - [Invoke a function call](saprfc-function)
+    - [Configure the SAP remote function call](saprfc-function)
 * [DateTime conversions for SAP](datetime)
 
 [koucky]: http://saprfc.sourceforge.net/ "SAPRFC extension module for PHP"

index.md

@@ -17,28 +17,4 @@ That lead to the following requirements:
 3. The configuration has to be as interchangeable as possible between the PHP
    modules.
 
-### Example: connect ➔ prepare ➔ invoke
-
-```php
-<?php
-
-use phpsap\saprfc\SapRfcConnection;
-use phpsap\saprfc\SapRfcConfigA;
-
-//stored configuration, JSON encoded
-$config = '{
-    "ashost": "sap.example.com",
-    "sysnr": "001",
-    "client": "01",
-    "user": "username",
-    "passwd": "password"
-}';
-//establish a connection using the stored configuration
-$connection = new SapRfcConnection(new SapRfcConfigA($config));
-//prepare a function call
-$function = $connection->prepareFunction('MY_COOL_SAP_REMOTE_FUNCTION');
-//call the remote function
-$result = $function->setParam('paramName', 'value')->invoke();
-```
-
 [koucky]: http://saprfc.sourceforge.net/ "SAPRFC extension module for PHP"

interfaces.md

@@ -8,6 +8,8 @@ Module Author            | Module      | supported PHP versions | PHP/SAP compos
 [Piers Harding][harding] | `sapnwrfc`  | PHP 5.x                | [![Packagist][harding-version-badge]][harding-packagist]
 [Gregor Kralik][kralik]  | `sapnwrfc`  | PHP 7.x                | [![Packagist][kralik-version-badge]][kralik-packagist]
 
+_Please note, that none of the module authors is affiliated with PHP/SAP or involved in this project._
+
 See the [status page](status) on build status, the code quality and the test coverage.
 
 [koucky]: http://saprfc.sourceforge.net/ "SAPRFC extension module for PHP"