Skip to content

Commit 02b3190

Browse files
authored
Update README.md
1 parent 5a6d8c5 commit 02b3190

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ The utility class uses a CBC mode encryption along with AES standard to provide
1212
* Integrate(include)
1313
* File Support
1414
* Cryptography Algorithms
15-
* C++ Pseudo Examples
15+
* C++ Examples
16+
* Unit Testing
1617

1718
## CLI Execution Flags
1819
You can Supply various flags to directly instruct the operation on how to execute, some of these flags are:
@@ -301,3 +302,11 @@ int main(int argc, char **argv)
301302
302303
```
303304
305+
## Unit Testing
306+
307+
For a quick test, there is a special static member function named `CreateTestDirectory`, which will create a test directory, and some files to test encryption.
308+
> the directory must not exists or test will fail, you can supply how many files you want with init-list argument, here creating a test directory with 2 files, the files will contain a trivial buffer, just for testint purposes.
309+
```cpp
310+
// this will return the full path of the directory if successfully created, an empty string otherwise, you can use it's value for later operations like target supply.
311+
const String_t create_test_dir = Crypto::CreateTestDirectory("/path/to/test/dir", {"file1.txt", "file2.txt"});
312+
```

0 commit comments

Comments
 (0)