|
8 | 8 | [](https://insight.sensiolabs.com/projects/0f8f9b12-2076-4d0e-a34e-c6f097c61b16) |
9 | 9 |
|
10 | 10 | [](https://packagist.org/packages/Spomky-Labs/base64url) [](https://packagist.org/packages/Spomky-Labs/base64url) [](https://packagist.org/packages/Spomky-Labs/base64url) [](https://packagist.org/packages/Spomky-Labs/base64url) |
| 11 | + |
| 12 | +This library aims to provide a fast Base64 URL Safe encoder/decoder as described by the [RFC 4648](https://tools.ietf.org/html/rfc4648). |
| 13 | + |
| 14 | +## The Release Process |
| 15 | + |
| 16 | +We manage the releases of the library through features and time-based models. |
| 17 | + |
| 18 | +- A new patch version comes out every month when you made backwards-compatible bug fixes. |
| 19 | +- A new minor version comes every six months when we added functionality in a backwards-compatible manner. |
| 20 | +- A new major version comes every year when we make incompatible API changes. |
| 21 | + |
| 22 | +The meaning of "patch" "minor" and "major" comes from the Semantic [Versioning strategy](http://semver.org/). |
| 23 | + |
| 24 | +This release process applies for all versions. |
| 25 | + |
| 26 | +### Backwards Compatibility |
| 27 | + |
| 28 | +We allow developers to upgrade with confidence from one minor version to the next one. |
| 29 | + |
| 30 | +Whenever keeping backward compatibility is not possible, the feature, the enhancement or the bug fix will be scheduled for the next major version. |
| 31 | + |
| 32 | +## Prerequisites |
| 33 | + |
| 34 | +This library needs at least |
| 35 | + |
| 36 | +* `PHP 5.0`. |
| 37 | + |
| 38 | +It has been successfully tested using `PHP 5.0` to `PHP 5.6` and `HHVM`. |
| 39 | + |
| 40 | +## Installation |
| 41 | + |
| 42 | +The preferred way to install this library is to rely on Composer: |
| 43 | + |
| 44 | + { |
| 45 | + "require": { |
| 46 | + // ... |
| 47 | + "spomky-labs/base64url": "*" |
| 48 | + } |
| 49 | + } |
| 50 | + |
| 51 | +## How to use |
| 52 | + |
| 53 | + |
| 54 | + <?php |
| 55 | + |
| 56 | + use Base64Url\Base64Url; |
| 57 | + |
| 58 | + $message = "Hello World!"; |
| 59 | + |
| 60 | + $encoded = Base64Url::encode($message); //Result must be "SGVsbG8gV29ybGQh" |
| 61 | + $decoded = Base64Url::decode($encoded); //Result must be "Hello World!" |
| 62 | + |
| 63 | +## Contributing |
| 64 | + |
| 65 | +Requests for new features, bug fixed and all other ideas to make this library usefull are welcome. [Please follow these best practices](doc/Contributing.md). |
| 66 | + |
| 67 | +## Licence |
| 68 | + |
| 69 | +This software is release under [MIT licence](LICENSE). |
0 commit comments