diff --git a/README.md b/README.md index 98e859b..6e72836 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ checkpw is a program that checks the validity of a users password on a Linux/PAM-based system. +``` +Usage: ./checkpw [-u ] [-p ] [-i] [-v] [-h] + +Options: + -u Specify username. + -p Specify password. + -i Enable interactive mode to prompt for missing username/password. + -v Enable verbose mode. + -h Show this help +``` + Returns 0 on success, 1 otherwise. # Installation: