rpcii-php/README.md
flashwave 93ec139171 Rename and a set of reworks.
- Aiwass -> RPCii
 - Swapped the meaning of "Procedure" and "Action"
 - IRpcActionHandler is now RpcHandler, abstract class no longer exists like Index
 - Anything suffixed by Trait is now suffixed by Common
 - All I prefixes on interfaces are gone
 - A PHP StreamWrapper implementation of HttpRequest added as a fallback for when cURL isnt installed
 - HttpRpcServer now hosts on /_rpcii instead of /_aiwass
 - Packagist package is now flashii/rpcii instead of flashwave/aiwass

That's probably all of it but I probably forgor.
2024-11-13 23:17:29 +00:00

34 lines
1.5 KiB
Markdown

# RPCii (旧Aiwass)
RPCii is an RPC client and server library.
An Index compatible route handler is provided to make it really low effort to get a server going.
## Requirements and Dependencies
RPCii currently targets **PHP 8.3** with the `msgpack` extension installed.
## Versioning
RPCii versioning will follows the [Semantic Versioning specification v2.0.0](https://semver.org/spec/v2.0.0.html).
Changes to minimum required PHP version other major overhauls to RPCii itself that break compatibility will be reasons for incrementing the major version.
RPCii depends on Index, but its versioning depends on the minimum PHP version and should thus be fairly inconsequential.
Previous major versions may be supported for a time with backports depending on what projects of mine still target older versions of PHP.
The version is stored in the root of the repository in a file called `VERSION` and can be read out within RPCii using `RPCii\RPCii::version()`.
## Contribution
By submitting code for inclusion in the main RPCii source tree you agree to transfer ownership of the code to the project owner.
The contributor will still be attributed for the contributed code, unless they ask for this attribution to be removed.
This is to avoid intellectual property rights traps and drama that could lead to blackmail situations.
If you do not agree with these terms, you are free to fork off.
## Licencing
RPCii is available under the BSD 3-Clause Clear License, a full version of which is enclosed in the LICENCE file.