diff --git a/README.rst b/README.rst index 45fbbea..794e270 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,36 @@ -# Usage +Internet Sabotage +================= -from internet_sabotage import no_connection +Python package to simulate internet failures for testing purposes. -with no_connection(): - response = requests.get('http://httpbin.org/ip') +Instalation +----------- + +.. code:: shell + + $ pip install internet-sabotage + +Usage +----- + +.. code:: python + + from internet_sabotage import no_connection + + with no_connection(): + response = requests.get('http://httpbin.org/ip') + +or + +.. code:: python + + from internet_sabotage import no_connection + + @no_connection + def test_something(): + pass + +License +------- + +MIT diff --git a/setup.py b/setup.py index d07b964..0754d37 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ setup( name='internet-sabotage', - version='0.1.0', + version='0.1.2', description='Disable network connection for Testing', long_description=long_description, author='André Luiz',