diff --git a/README.md b/README.md new file mode 100644 index 0000000..e8f5004 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +### Installation +Run this command in your terminal to install pmf-suspend to your path. +`sudo ./pmf-suspend-install` + + +### Usage + pmf-suspend Suspend system instantly + pmf-suspend [help|--help] Show this message + pmf-suspend 1 2 3 Timer will be set to 1s, 2m, 3h + pmf-suspend 0 30 Timer will be set to 30 mintues + + +### Info + Author: Livila + Version: 1.0 + + This program is used for when you want to suspend your computer with a timer. + As pm-suspend does not lock the screen on several of the latest versions, this + will do that automatically when the timer is finished. + + The command pmf-suspend stands for power manager (fix) suspend. + + In order to suspend the system this program must be run as root.