From 1a581abeddc0ca81cd01778aef348e6daf553f18 Mon Sep 17 00:00:00 2001
From: TonyJosi97 <tonyjosinew@gmail.com>
Date: Tue, 14 Sep 2021 12:40:33 -0700
Subject: [PATCH] readme modified

---
 readme.md | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/readme.md b/readme.md
index 74173a0..f5f5754 100644
--- a/readme.md
+++ b/readme.md
@@ -28,19 +28,19 @@ Encrypts/Decrypts 3.71 GB data in ~18 seconds on 2.90 GHz Hexa-Core Intel® Core
 
 ### Build & Run
 
-Requires [cmake](https://cmake.org/) to build. Optional - Google Test
+Requires [cmake](https://cmake.org/) to build. Optional - [google test](https://en.wikipedia.org/wiki/Google_Test) and [pybind11](https://pybind11.readthedocs.io/en/stable/faq.html)
 
 Uses Google Test for unit testing.
 
-1. Clone project - The project uses use [google test](https://en.wikipedia.org/wiki/Google_Test) and [pybind11](https://pybind11.readthedocs.io/en/stable/faq.html) external submodules, if testing and generation of python bindings for the AES library are required (not mandatory for normal build) then those external modules can be cloned using the command:  `git submodule update --init --recursive`.
+1. Clone project - The project uses use [`google test`](https://en.wikipedia.org/wiki/Google_Test) and [`pybind11`](https://pybind11.readthedocs.io/en/stable/faq.html) external submodules, if testing and generation of python bindings for the AES library are required (not mandatory for normal build) then those external modules can be cloned using the command:  `git submodule update --init --recursive`.
 
 2. Build project - The project uses CMake generator for generating build files. Use `-DENABLE_TESTING=ON` for building test library and test cases and `-DPYTHON_BINDINGS_GEN=ON` for generating python bindings module.
 
 ``` sh
 cd aes
 mkdir build && cd build
-cmake .. -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTING=OFF -DLOW_LEVEL_API_SAMPLE=ON -DWARNINGS_AS_ERRORS=OFF -DENABLE_I
-PO=ON # Test disabled; use -DENABLE_TESTING=ON to build test cases executable. Not building python bindings by default, use -DPYTHON_BINDINGS_GEN=ON if required.
+cmake .. -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTING=OFF -DLOW_LEVEL_API_SAMPLE=ON -DWARNINGS_AS_ERRORS=OFF -DENABLE_IPO=ON 
+# Test disabled; use -DENABLE_TESTING=ON to build test cases executable. Not building python bindings by default, use -DPYTHON_BINDINGS_GEN=ON if required.
 ```
 
 After generating the build files the target can be build using the build tools supported by the current platform. (`make` for Unix systems, `Visual Studio` for Windows and `Xcode` for MacOS)
@@ -135,6 +135,10 @@ int main() {
 }
 ```
 
+### Large file encryption API with multi-threaded file IO
+
+For example usage please refer to: [`process_file.cpp`](https://github.com/TonyJosi97/aes/blob/master/src/process_file.cpp) file
+
 ### Example usage of the python bindings module
 
 If `-DPYTHON_BINDINGS_GEN=ON` option is given during the CMake build file generation the build tools will build the python bindings, the default name for the python module is `py_sc_aes`.