diff --git a/README.md b/README.md index c91d679..b7d6b4d 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,17 @@ Stéganô A Python Steganography module. -# Installation +Installation +------------ $ sudo pip install Stegano -# Use Stéganô as a library in your Python program +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: +If you want to use Stéganô in your Python program you just have to import the +appropriate steganography technique. For example: >>> from stegano import slsb @@ -19,7 +22,8 @@ If you want to use Stéganô in your Python program you just have to import the >>> secret.save("./Lenna-secret.png") -# Use Stéganô as a program +Use Stéganô as a program +------------------------ In addition you can use Stéganô as a program. @@ -32,16 +36,19 @@ Another example (hide the message with Sieve of Eratosthenes): $ slsb-set --hide -i ../examples/pictures/Lenna.png -o Lena2.png --generator eratosthenes -m 'Secret Message' -# Examples +Examples +-------- There are some examples in the folder *examples*. -# Turorial +Turorial +-------- -A [tutorial](https://stegano.readthedocs.org/en/latest/tutorial/) is available. +A [tutorial](https://stegano.readthedocs.org/en/latest/tutorial) is available. -# Contact +Contact +------- [My home page](https://www.cedricbonhomme.org). diff --git a/setup.py b/setup.py index 74f6600..cd5319b 100644 --- a/setup.py +++ b/setup.py @@ -19,6 +19,8 @@ requires = ['pillow'] with open('README.md', 'r') as f: readme = f.read() +with open('CHANGELOG.md', 'r') as f: + changelog = f.read() setup( name='Stegano', @@ -30,7 +32,7 @@ setup( scripts=['bin/slsb', 'bin/slsb-set', 'bin/steganalysis-parity'], url='https://bitbucket.org/cedricbonhomme/stegano', description='A Python Steganography module.', - long_description=readme, + long_description=readme + changelog, platforms = ['Linux'], license='GPLv3', install_requires=requires,