Updated README.

This commit is contained in:
Cédric Bonhomme 2018-02-27 23:04:03 +01:00
parent ea406bf4d1
commit d5490006d5
No known key found for this signature in database
GPG key ID: A1CB94DE57B7A70D

View file

@ -1,4 +1,4 @@
Stéganô
Stegano
=======
.. image:: https://img.shields.io/pypi/pyversions/Stegano.svg?style=flat-square
@ -23,13 +23,13 @@ Stéganô
:target: https://saythanks.io/to/cedricbonhomme
`Stéganô <https://github.com/cedricbonhomme/Stegano>`_, a pure Python
`Stegano <https://github.com/cedricbonhomme/Stegano>`_, a pure Python
Steganography module.
Steganography is the art and science of writing hidden messages in such a way
that no one, apart from the sender and intended recipient, suspects the
existence of the message, a form of security through obscurity. Consequently,
functions provided by Stéganô only hide messages, without encryption.
functions provided by Stegano only hide messages, without encryption.
Steganography is often used with cryptography.
Installation
@ -39,9 +39,12 @@ Installation
$ pipenv install Stegano
You will be able to use Stéganô in your Python programs or as a command line
tool.
You will be able to use Stegano in your Python programs.
If you only want to install Stegano as a command line tool:
.. code:: bash
$ pipsi install Stegano
Usage
-----
@ -49,10 +52,10 @@ Usage
A `tutorial <https://stegano.readthedocs.io>`_ is available.
Use Stéganô as a library in your Python program
Use Stegano as a library in your Python program
'''''''''''''''''''''''''''''''''''''''''''''''
If you want to use Stéganô in your Python program you just have to import the
If you want to use Stegano in your Python program you just have to import the
appropriate steganography technique. For example:
.. code:: python
@ -64,8 +67,8 @@ appropriate steganography technique. For example:
>>> clear_message = lsb.reveal("./Lenna-secret.png")
Use Stéganô as a program
''''''''''''''''''''''''
Use Stegano as a command line tool
''''''''''''''''''''''''''''''''''
Hide and reveal a message
~~~~~~~~~~~~~~~~~~~~~~~~~