Skip to content

Commit ac123cf

Browse files
authored
Update README.md
1 parent 9013399 commit ac123cf

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@ Stegastatter is a steganography engine that uses LSB (Least Significant Bit) and
33
Apart from steganography/steganalysis, Stegastatter uses a wrapping mechanism that consists of encryption, byte shuffling, and error correction.
44
A theoretical overview for the concepts in this project can be found [here](https://github.com/Jebbex1/Stegastatter/blob/main/Stegastatter%20Theoretical%20Overview.docx).
55

6-
## Usage Notes
7-
This module is unsafe in reguard to errror handling. If the functions of this module are called with improper parameters / with invalid data (e.g. attempting to extract data from an image with no data hidden in it), errors will be raised.
8-
Consult the errors.py file for info on different errors.
6+
## Why the low commit count?
7+
Originally, this project was [Stegastatter-Wrapper](https://github.com/Jebbex1/Stegastatter-Wrapper), but I wanted to isolate the engine from the client/server structure to then publish it to PyPI.
8+
If you are looking for the all the commits from the development of the engine/wrapper, please visit [this page](https://github.com/Jebbex1/Stegastatter-Wrapper/commits/main/).
99

1010
## Instellation
1111
As of 1.0.2, this module is available only on PyPI, instellation via pip:
1212
```
1313
pip install stegastatter
1414
```
15+
16+
## Usage Notes
17+
This module is unsafe in reguard to errror handling. If the functions of this module are called with improper parameters / with invalid data (e.g. attempting to extract data from an image with no data hidden in it), errors will be raised.
18+
Consult the errors.py file for info on different errors.

0 commit comments

Comments
 (0)