From a62063849f19178feae5f1de9695faeeb35cd8a8 Mon Sep 17 00:00:00 2001 From: Dorian Pula Date: Thu, 12 Jul 2018 14:29:51 -0400 Subject: [PATCH] Add a better README for this utility. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e69de29..b0392ee 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,13 @@ +# check-package + +Do you hate it when your Python package doesn't install? + +Want to know if you setup your Python package correctly? + +`check-package` is a utility for verifying if your Python package is +installable. + +## How Does It Work? + +`check-package` will create a virtual environment, attempt to install the +target package, and run post-install tests if applicable.