32 lines
1.3 KiB
Markdown
32 lines
1.3 KiB
Markdown
|
# Flashii PHP API client
|
||
|
|
|
||
|
|
This is the source for the first party Flashii API client implementation in PHP.
|
||
|
|
|
||
|
|
## Requirements and Dependencies
|
||
|
|
|
||
|
|
This library currently targets **PHP 8.1**.
|
||
|
|
|
||
|
|
|
||
|
|
## Versioning
|
||
|
|
|
||
|
|
Versioning will follows the [Semantic Versioning specification v2.0.0](https://semver.org/spec/v2.0.0.html).
|
||
|
|
|
||
|
|
The MAJOR version component will always be in sync with the implemented version of the Flashii API.
|
||
|
|
|
||
|
|
The MINOR version component will be incremented depending changes to the library itself, be it feature additions or removals or changes to minimum required PHP version.
|
||
|
|
|
||
|
|
The version is stored in the root of the repository in a file called `VERSION` and can be read using `Flashii\FlashiiClient::version()`.
|
||
|
|
|
||
|
|
|
||
|
|
## Contribution
|
||
|
|
|
||
|
|
By submitting code for inclusion in the main 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
|
||
|
|
|
||
|
|
The Flashii API client is available under the BSD 3-Clause Clear License, a full version of which is enclosed in the LICENCE file.
|