From 341bcfb53880a1573e6dadbc9e47f931cf6781a6 Mon Sep 17 00:00:00 2001 From: Eric Hanko Date: Wed, 7 Jun 2017 15:41:54 -0700 Subject: [PATCH] Update usage --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 100665e..670ce7f 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,22 @@ ### systemsetup -The systemsetup resource wraps the `/usr/sbin/systemsetup` tool and can be used in -almost exactly the same way as it is used on the command line. +The systemsetup resource is a wrapper for `/usr/sbin/systemsetup`. Use the `get` and `set` properties with hashes or +strings in order to get or set the desired setting. -Example usage: +Example "set" usage: ```ruby -systemsetup 'keep machine awake indefinitely' do - settings remotelogin: 'On', - waitforstartupafterpowerfailure: 0, - displaysleep: 0 +systemsetup 'keep awake and get time information' do + set sleep: 0, + computersleep: 0, + displaysleep: 0, + harddisksleep: 0 + get %w(networktimeserver timezone) end ``` + #### Available settings to use with the `systemsetup` resource: date