diff --git a/README.md b/README.md index df87065..db1c65e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,28 @@ # qrz.sh -QRZ.com callsign data query script written in Bash This script queries the QRZ.com callsign database and returns the result to the command line. A XML subscription plan with QRZ.com is required for full functionality. -usage: ./qrz.sh +![screenshot](/screenshot.jpg?raw=true "screenshot") +# Installation + +* Copy the file _.qrz.conf_ into your home directory +* Copy the file _qrz.sh_ into a directory that is in you PATH variable +* Set the correct file permissions: _chmod u+x qrz.sh_ + +# Configuration + +Edit the file _~/.qrz.conf_ like this: + +``` +user= +password= +``` + +# Usage + +``` +# qrz.sh +```