Updated README.

This commit is contained in:
Cédric Bonhomme 2015-12-23 20:59:39 +01:00
parent 9617f8c2fd
commit 1297fa84ec
No known key found for this signature in database
GPG key ID: A1CB94DE57B7A70D

View file

@ -7,6 +7,8 @@ A Python Steganography module.
Installation
------------
.. code:: bash
$ sudo pip install Stegano
@ -16,6 +18,7 @@ Use Stéganô as a library in your Python program
If you want to use Stéganô in your Python program you just have to import the
appropriate steganography technique. For example:
.. code:: python
>>> from stegano import slsb
>>> secret = slsb.hide("./pictures/Lenna.png", "Hello Workd")
@ -29,10 +32,14 @@ In addition you can use Stéganô as a program.
Example:
.. code:: bash
$ slsb --hide -i ../examples/pictures/Lenna.png -o Lena1.png -m "Secret Message"
Another example (hide the message with Sieve of Eratosthenes):
.. code:: bash
$ slsb-set --hide -i ../examples/pictures/Lenna.png -o Lena2.png --generator eratosthenes -m 'Secret Message'
@ -41,6 +48,8 @@ Examples
There are some examples in the folder *examples*.
.. code:: bash
$ git clone https://github.com/cedricbonhomme/Stegano.git
$ cd stegano/examples