Skip to content

Commit 647a915

Browse files
Add missing README.md
1 parent 73fcf5a commit 647a915

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

encryption_helper/utils/README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<!-- markdownlint-disable MD033 MD041 -->
2+
<p align="center">
3+
<img src="https://www.hsbc.com/-/files/hsbc/header/hsbc-logo-200x25.svg" alt="HSBC Logo" width="200" title="HSBC Logo">
4+
</p>
5+
6+
<h1 align="center">Encryption Helper Python</h1>
7+
8+
<p align="center">
9+
<img src="../../assets/banner.jpg" alt="Encryption Helper Banner">
10+
</p>
11+
12+
<h2 align="center">Checks and I/O Modules Overview</h2>
13+
14+
<p align="center">
15+
<strong>This package includes various modules for encryption helper functionalities.</strong>
16+
</p>
17+
18+
<p align="center">
19+
<a href="#checks-module">Checks Module</a> •
20+
<a href="#io-modules">I/O Modules</a> •
21+
<a href="#license">License</a>
22+
</p>
23+
<!-- markdownlint-enable MD033 MD041 -->
24+
25+
## Checks Module
26+
27+
The Checks module in the `encryption_helper` package provides utility functions for input validation.
28+
29+
For detailed documentation, please refer to the `README.md` file in the respective folder:
30+
31+
- [Checks Module](checks/README.md)
32+
33+
## I/O Modules
34+
35+
The I/O modules in the `encryption_helper` package provide functionalities for reading and writing files in binary mode.
36+
37+
- **Read File Module**: Functions to read text files in binary mode.
38+
- **Write File Module**: Functions to write text files in binary mode.
39+
40+
For detailed documentation, please refer to the `README.md` files in the respective folders:
41+
42+
- [Read File Module](io/README.md)
43+
- [Write File Module](io/README.md)
44+
45+
## License
46+
47+
This project is licensed under the MIT License. See the [LICENSE](../../LICENSE) file for details.

0 commit comments

Comments
 (0)