Skip to content

Commit 6fc57ad

Browse files
author
Spomky
committed
Tests added
1 parent cc5aebb commit 6fc57ad

File tree

6 files changed

+973
-1
lines changed

6 files changed

+973
-1
lines changed

.travis.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
language: php
22

33
php:
4+
- 5.0
5+
- 5.1
6+
- 5.2
47
- 5.3
58
- 5.4
69
- 5.5

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,62 @@
88
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/0f8f9b12-2076-4d0e-a34e-c6f097c61b16/big.png)](https://insight.sensiolabs.com/projects/0f8f9b12-2076-4d0e-a34e-c6f097c61b16)
99

1010
[![Latest Stable Version](https://poser.pugx.org/Spomky-Labs/base64url/v/stable.png)](https://packagist.org/packages/Spomky-Labs/base64url) [![Total Downloads](https://poser.pugx.org/Spomky-Labs/base64url/downloads.png)](https://packagist.org/packages/Spomky-Labs/base64url) [![Latest Unstable Version](https://poser.pugx.org/Spomky-Labs/base64url/v/unstable.png)](https://packagist.org/packages/Spomky-Labs/base64url) [![License](https://poser.pugx.org/Spomky-Labs/base64url/license.png)](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).

composer.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@
2222
}
2323
},
2424
"require": {
25-
"php": ">=5.3"
25+
"php": ">=5.0"
26+
},
27+
"require-dev": {
28+
"phpunit/phpunit": "~4.0"
2629
},
2730
"extra": {
2831
"branch-alias": {

0 commit comments

Comments
 (0)