Skip to content

Commit e0ee03b

Browse files
committed
chore: improved README
1 parent 74aa96c commit e0ee03b

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,33 @@
1-
## PHP Base62x Library
1+
# PHP Base62x Library
22

33
This library can be used to encode strings in **Base62x** format.
44

5-
The reference implementation of Base62x has been taken by this repository: https://github.com/wadelau/Base62x
5+
The reference implementation of _Base62x_ has been taken by this repository: [https://github.com/wadelau/Base62x](https://github.com/wadelau/Base62x)
66

77
Stating the original author repository, **Base62x is an alternative approach to Base 64 without symbols in output.**
88

9-
Base62x is an **non-symbolic Base64 encoding scheme**. It can be used safely in computer file systems, programming languages for data exchange, internet communication systems, etc, and it is an ideal substitute and successor of many variants of Base64 encoding scheme.
9+
_Base62x_ is an **non-symbolic Base64 encoding scheme**. It can be used safely in computer file systems, programming languages for data exchange, internet communication systems, etc, and it is an ideal substitute and successor of many variants of Base64 encoding scheme.
1010

1111
This repository is a wrapper around **wadelau/Base62x** repository, and is specifically crafted for PHP, with composer support.
1212

13-
It can be integrated into any framework, like Laravel, to enable Base62x support out of the box.
13+
It can be integrated into any framework, like Laravel, to enable _Base62x_ support out of the box.
1414

1515
[![Latest Stable Version](https://poser.pugx.org/mfonte/base62x/v/stable)](https://packagist.org/packages/mfonte/base62x)
1616
[![Total Downloads](https://poser.pugx.org/mfonte/base62x/downloads)](https://packagist.org/packages/mfonte/base62x)
1717
[![Build Status](https://scrutinizer-ci.com/g/mauriziofonte/php-base62x/badges/build.png?b=master)](https://scrutinizer-ci.com/g/mauriziofonte/php-base62x/)
1818
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mauriziofonte/php-base62x/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mauriziofonte/php-base62x/)
1919

20-
### Installation
20+
## Installation
2121

2222
Simple enough.
2323

2424
`composer require mfonte/base62x`
2525

26-
Required **PHP >= 7.1** and php's **gzip** support for gzip compression.
26+
Required environment:
27+
28+
1. PHP **>= 7.2**
29+
2. `gzip` module, for gzip compression support
30+
3. `openssl` module, for encryption support
2731

2832
### Use cases
2933

0 commit comments

Comments
 (0)