Skip to content

Commit

Permalink
Merge pull request #11 from izcoser/master
Browse files Browse the repository at this point in the history
Improve README.md
  • Loading branch information
dhsdshdhk authored Aug 31, 2022
2 parents c69073d + fbda9f2 commit 9a23a95
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# stegpy

A program for encoding information in image and audio files through steganography.
<p align="middle">
<img src="https://files.catbox.moe/4t5f8u.gif"/>
</p>

A program for encoding information in image and audio files through steganography. Any type of data can be encoded, from raw strings to files, as shown below:

<p align="middle">
<img src="https://github.com/kamihfkjkf/stegpy/blob/master/images/house.png?raw=true"/>
Expand All @@ -10,7 +14,7 @@ A program for encoding information in image and audio files through steganograph
On the left, a house with a steganographically hidden image. On the right, the extracted hidden image of a cat. It is revealed by removing all but the least significant bit of each color component in the host image.

***
Supported host formats:
## Supported host formats
* PNG
* BMP
* GIF
Expand All @@ -20,26 +24,29 @@ Supported host formats:
Images in a different format are automatically converted to PNG. Different audio formats are not supported at all.

***
Dependencies:
## Dependencies
* numpy
* cryptography
* Pillow (PIL fork)
***
Install:
## Installation
```sh
pip3 install stegpy
```
***
How to use:
* Hide a message or file:
## Usage:
### Hide a message or file:
```sh
stegpy "Hello World!" image.png
```
* Extract it:
### Extract it:
```sh
stegpy _image.png
```
* Encrypt:

Data is encoded without any protection by default, but it can be encrypted with the ```-p``` flag:

### Encrypt:
```sh
stegpy "Hello World!" image.png -p
Enter password (will not be echoed):
Expand All @@ -48,12 +55,13 @@ Verify password (will not be echoed):
Enter password (will not be echoed):
Hello World!
```
* More options:
### More options:
```sh
stegpy -h
```
***
To do:
## To do
* Add docstrings
* Allow encoding across multiple files
* Support JPEG & FLAC as hosts

0 comments on commit 9a23a95

Please sign in to comment.