ref: update readme

README.md

@@ -1,5 +1,8 @@
 # Coredump Uploader
 
+This utility can upload core dumps to Sentry.  It can either upload a single core dump or watch a folder
+for incoming core dumps to automatically upload them as they happen.
+
 ## Requirements
 
 - python

coredump_uploader/__init__.py

@@ -601,7 +601,11 @@ class CoredumpUploader(object):
 )
 @click.pass_context
 def cli(context, path_to_executable, sentry_dsn, gdb_path, elfutils_path, all_threads):
-    """Initialize Sentry-dsn and Coredump-uploader"""
+    """Sentry coredump uploader
+
+    This utility can upload core dumps to sentry by stack walking them with the help
+    of GDB.
+    """
     sentry_sdk.init(sentry_dsn, max_breadcrumbs=0)
     uploader = CoredumpUploader(
         path_to_executable, sentry_dsn, gdb_path, elfutils_path, all_threads

pyproject.toml

@@ -5,7 +5,7 @@ description = ""
 authors = ["Dominik Rindhauser <dominik.rindhauser@sentry.io>"]
 
 [tool.poetry.dependencies]
-python = "^2.7"
+python = "^2.7 || ^3.5"
 sentry-sdk = "^0.14.1"
 click = "^7.0"
 watchdog = "^0.8.2"
@@ -14,7 +14,7 @@ watchdog = "^0.8.2"
 pytest = "^4.6.9"
 
 [tool.poetry.scripts]
-upload_coredump = "coredump_uploader:main"
+upload_coredump = "coredump_uploader:cli"
 
 [build-system]
 requires = ["poetry>=0.12"]