updated README.md

Description.txt

+== A tool to manage certificate lifecycle on Vault, Redis, Consul
+
+this tool is used in conjunction with certbot to upload certificates to Vault, Redis and Consul

README.md

@@ -4,8 +4,8 @@
 
 ## Build & Install the package
 
-The version number is define in `./version/__init__.py`\
-We assume that we have version `0.5.0`
+The version number is defined in `./version/__init__.py`\
+In this README we assume that we are using version `0.5.0`
 
 ### Use pip
 
@@ -18,17 +18,17 @@ pip install dist wile_coyote-0.5.0-py3-none-any.whl
 
 ```sh
 python3 setup.py bdist_rpm
-rpm -Uvh dist/wile_coyote-0.5.0-1.noarch.rpm
+sudo rpm -Uvh dist/wile_coyote-0.5.0-1.noarch.rpm
 ```
 
 ### Use DEB
 
-sudo is required for both install the packages and create the debian package\
-`DEB_BUILD_OPTIONS=nocheck` is necessary because `dh_auto_test` reset `$HOME` and the unit test will not find `acme.ini`
+`DEB_BUILD_OPTIONS=nocheck` is required because `dh_auto_test` resets `$HOME` variable and the unit test fails because it won't find `acme.ini`
 
 ```sh
 sudo apt install python3-stdeb fakeroot python-all dh-python
 DEB_BUILD_OPTIONS=nocheck python3 setup.py --command-packages=stdeb.command bdist_deb
+sudo dpkg -i deb_dist/python3-wile-coyote_0.5.0-1_all.deb
 ```
 
 ## create README.rst

setup.py

@@ -21,7 +21,7 @@ setup(
     name="wile_coyote",
     version=VERSION,
     description="A tool to manage certificates on Vault, Redis, Consul",
-    long_description=read('README.rst'),
+    long_description=read('Description.txt'),
     url="https://gitlab.geant.net/devops/wile_coyote",
     install_requires=[
         'configparser==5.0.2',
@@ -41,7 +41,6 @@ setup(
     zip_safe=False
 )
 
-
 print('removing stale items')
 for stale_files in glob('*/*.pyc') + glob('wile_coyote-*tar.gz'):
     try:

stdeb.cfg

 [DEFAULT]
 Copyright-File: LICENSE.md
-