From 0353abbd93dc97ad604dc5b33cb441ceccfe28c7 Mon Sep 17 00:00:00 2001 From: Vincent Batts Date: Fri, 5 Jul 2013 10:49:43 -0400 Subject: [PATCH] adding info to the README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 0871520..01ba81b 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,24 @@ go-lockout ========== simple app for exec'ing my desired screen lock and suspend functions + +Installation +============ + +This tool is built using Google Go Lang + + go get github.com/vbatts/go-lockout/lockout + + +Usage +===== + +Set ~/.config/lockout.conf to have two variables, with the values what it takes to accomplish locking your screensaver, and to suspend your laptop + + suspendcmd: sudo /usr/sbin/pm-suspend + lockcmd: xscreensaver-command -lock + +Then you can just call + + lockout +