Skip to content

Commit 24caf25

Browse files
committed
add documentation link to readme and composer
1 parent 4df96cb commit 24caf25

File tree

2 files changed

+5
-15
lines changed

2 files changed

+5
-15
lines changed

README.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,11 @@
11
# PHP/SAP interfaces
22

3-
**ATTENTION: THIS IS WORK IN PROGRESS AND NOT TO BE USED UNTIL THIS MESSAGE DISAPPEARS!**
4-
53
[![License: MIT][license-mit]](LICENSE)
64

75
This repository defines interfaces for implementing the [PHP/SAP][phpsap] API.
86

9-
## Interfaces
10-
11-
The following interfaces are available in namespace `phpsap\interfaces`:
12-
13-
* `IConfig` Configure basic connection parameters for SAP remote function calls, that are common to both connection types (A, and B).
14-
* `IConfigA` Configure connection parameters for SAP remote function calls using a specific SAP application server (type A).
15-
* `IConfigB` Configure connection parameters for SAP remote function calls using load balancing (type B).
16-
* `IConnection` Manage a PHP/SAP connection instance.
17-
* `IFunction` Manage a PHP/SAP remote function call.
18-
* `ISapException` Generic SAP exception.
19-
* `IConnectionFailedException` The SAP connection failed.
20-
* `IUnknownFunctionException` The requested remote function could not be found.
21-
* `IFunctionCallException` The SAP remote function call failed.
7+
[See PHP/SAP Interfaces for documentation][doc]
228

239
[phpsap]: https://php-sap.github.io
2410
[license-mit]: https://img.shields.io/badge/license-MIT-blue.svg
11+
[doc]: https://php-sap.github.io/interfaces "Interfaces | PHP/SAP"

composer.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
}
1212
],
1313
"homepage": "https://php-sap.github.io",
14+
"support": {
15+
"docs": "https://php-sap.github.io/interfaces"
16+
},
1417
"keywords": [
1518
"phpsap",
1619
"php-sap",

0 commit comments

Comments
 (0)