adding info to the README

This commit is contained in:
Vincent Batts 2013-07-05 10:49:43 -04:00
parent c7eb842ec7
commit 0353abbd93

View file

@ -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