diff --git a/README.md b/README.md index 74e419c..475837e 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -# QRTool \ No newline at end of file +# QRTool + +QRTool is a simple tool to generate QR codes from the command line. + +## Installation + +Clone the repo, and change directory into it. +Then: +``` +pipx install . +``` + +## Usage + +``` +qrtool --help +``` \ No newline at end of file