From ac66a9b4714cc85c84412a50d5b03356e4b1643f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Bonhomme?= Date: Wed, 18 May 2016 09:05:18 +0200 Subject: [PATCH] Updated README. --- README.rst | 37 +++++++++++++------------------------ 1 file changed, 13 insertions(+), 24 deletions(-) diff --git a/README.rst b/README.rst index a024bd0..955d4d0 100644 --- a/README.rst +++ b/README.rst @@ -14,9 +14,19 @@ Installation $ sudo pip install Stegano +You will be able to use Stéganô in your Python programs or as a command line +tool. + + +Usage +----- + +A `tutorial `_ is available. + +There are also some examples in the folder `examples `_. 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: @@ -29,34 +39,19 @@ appropriate steganography technique. For example: Use Stéganô as a program ------------------------- - -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): +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' -Examples --------- - -There are some examples in the folder *examples*. - -.. code:: bash - - $ git clone https://github.com/cedricbonhomme/Stegano.git - $ cd stegano/examples - - Running the tests ----------------- @@ -65,12 +60,6 @@ Running the tests $ python -m unittest discover -v -Turorial --------- - -A `tutorial `_ is available. - - Contact -------