From 171bdc5090388c45df13c9f38a0899dc7297e999 Mon Sep 17 00:00:00 2001 From: Dan Walters <dan@walters.io> Date: Thu, 13 Aug 2015 09:33:54 -0500 Subject: [PATCH] Change npm install to global, and add some additional documentation regarding key retrieval on the iPhone. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 663681b..ecbb209 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,11 @@ Also tested and working on OSX Yosemite. ## Install - npm install augustctl + npm install -g augustctl ## Configuration -It's necessary to have an `offlineKey` and corresponding `offlineKeyOffset` that are recognized by your lock. +It's necessary to have an `offlineKey` and corresponding `offlineKeyOffset` that are recognized by your lock. These should placed in a `config.json` file, which should be in your current directory when you run `augustctl`. ### Android Phone (with Root) @@ -51,6 +51,10 @@ The key and offset can be found in plist located at: This can be retrieved by using a file explorer like [http://www.i-funbox.com/ifunboxmac/](iFunBox), and opening the plist in Xcode. +Alternatively, you can enter the debug mode in the application by long pressing the application version number, entering the password (like in Android, it is `KryspyKym`) and e-mailing yourself the application logs. Search those logs for "offline", and you'll find the key and slot that are used by your device. + +Note that the key and slot will be all that is necessary to open your lock, so it's not advisable to leave those logs laying around in your e-mail account. + ## Usage Assuming you've configured your offline key and offset, as above, just: -- GitLab