Skip to content

Commit 113e982

Browse files
committed
update readme
1 parent c81b656 commit 113e982

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
# Laravel MySql AES Encrypt/Decrypt
22

3+
[![Latest Stable Version](https://poser.pugx.org/chr15k/laravel-mysql-encrypt/v)](//packagist.org/packages/chr15k/laravel-mysql-encrypt) [![Latest Unstable Version](https://poser.pugx.org/chr15k/laravel-mysql-encrypt/v/unstable)](//packagist.org/packages/chr15k/laravel-mysql-encrypt) [![Total Downloads](https://poser.pugx.org/chr15k/laravel-mysql-encrypt/downloads)](//packagist.org/packages/chr15k/laravel-mysql-encrypt) [![License](https://poser.pugx.org/chr15k/laravel-mysql-encrypt/license)](//packagist.org/packages/chr15k/laravel-mysql-encrypt)
4+
35
Laravel database encryption at database side using native AES_DECRYPT and AES_ENCRYPT functions.
46
Automatically encrypt and decrypt fields in your Models.
57

6-
## 1. Install
8+
## Install
9+
### 1. Composer
710
```bash
811
composer require chr15k/laravel-mysql-encrypt
912
```
1013

11-
## 2. Publish config (optional)
14+
### 2. Publish config (optional)
1215
```bash
1316
php artisan vendor:publish --provider="Chr15k\MysqlEncrypt\MysqlEncryptServiceProvider"
1417
```
1518

16-
## 3. Configure Provider (Laravel 5.4 or earlier)
19+
### 3. Configure Provider (Laravel 5.4 or earlier)
1720
For Laravel 5.4 or earlier, you'll need to add the following to config/app.php:
1821

1922
```php
@@ -22,7 +25,7 @@ For Laravel 5.4 or earlier, you'll need to add the following to config/app.php:
2225
)
2326
```
2427

25-
## 4. Set encryption key in `.env` file
28+
### 4. Set encryption key in `.env` file
2629
```
2730
APP_AESENCRYPT_KEY=yourencryptionkey
2831
```
@@ -65,3 +68,6 @@ DB::statement('ALTER TABLE `users` ADD `last_name` VARBINARY(300)');
6568
DB::statement('ALTER TABLE `users` ADD `email` VARBINARY(300)');
6669
DB::statement('ALTER TABLE `users` ADD `telephone` VARBINARY(50)');
6770
```
71+
72+
## License
73+
The MIT License (MIT). Please see [License File](https://github.com/chr15k/laravel-mysql-encrypt/blob/master/LICENSE) for more information.

0 commit comments

Comments
 (0)