Skip to content

Commit 92e1ef9

Browse files
committed
Improve documentation
1 parent 6e2f065 commit 92e1ef9

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Sidus/EncryptionBundle
22
====================
33

4-
Easy entity and file encryption for Symfony2.
4+
Easy entity and file encryption for Symfony.
55

66
We wanted to be able to store encrypted data in our Symfony2 applications and we realized that there were no simple way
77
to do it.
@@ -20,6 +20,35 @@ The main weakness of this system is that the cipher key is stored temporarly in
2020
overcome this problem would be to use a pretty complex asymmetric encryption system between the client and the server
2121
which could only be done properly using a rich client.
2222

23+
Installation
24+
------------
25+
```shell
26+
composer require cleverage/encryption-bundle
27+
```
28+
29+
30+
Usage
31+
-----
32+
33+
```php
34+
35+
use Doctrine\ORM\Mapping as ORM;class MyEntity {
36+
37+
/**
38+
* @ORM\Column(type="encrypt_string")
39+
*/
40+
private string $myField;
41+
42+
/**
43+
* @ORM\Column(type="encrypt_text")
44+
*/
45+
private string $myFieldText;
46+
}
47+
48+
```
49+
50+
51+
2352
Helpers
2453
-------
2554
This bundle comes with an EncryptionManager class which can be used in standalone to encrypt and decrypt data and files.

0 commit comments

Comments
 (0)