35 lines
1.5 KiB
Markdown
35 lines
1.5 KiB
Markdown
|
# Aiwass
|
||
|
|
|
||
|
|
Aiwass 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
|
||
|
|
|
||
|
|
Aiwass currently targets **PHP 8.3** with the `msgpack` extension installed.
|
||
|
|
|
||
|
|
|
||
|
|
## Versioning
|
||
|
|
|
||
|
|
Aiwass 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 Aiwass itself that break compatibility will be reasons for incrementing the major version.
|
||
|
|
|
||
|
|
Aiwass 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 Aiwass using `Aiwass\Aiwass::version()`.
|
||
|
|
|
||
|
|
|
||
|
|
## Contribution
|
||
|
|
|
||
|
|
By submitting code for inclusion in the main Aiwass 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
|
||
|
|
|
||
|
|
Aiwass is available under the BSD 3-Clause Clear License, a full version of which is enclosed in the LICENCE file.
|