From a6dfda64e29d9530ae35ad9cab80bdf6474f1c4c Mon Sep 17 00:00:00 2001 From: snicker Date: Mon, 30 Sep 2013 13:14:45 -0700 Subject: [PATCH] Update README.md Added install instructions and link to latest release, moved the configuration section up --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5cb107f..1b0b9c0 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,22 @@ HabitRPG-CLI integrates with [Growl for Windows][3] to send a notification upon [2]: http://www.autoitscript.com/site/ (AutoIT) [3]: http://www.growlforwindows.com/ (Growl for Windows) +Installation +------------ +* Grab the ZIP file for the latest release from [here][i1]. +* Unzip the file where ever you want (I recommend somewhere you can find it again) +* Follow the configuration instructions below! + +[i1]: https://github.com/snicker/HabitRPG-CLI/releases/tag/0.1.1.0 (Latest release) + +### Configuration + +You will need to edit the "habitrpg.ini" file in the same folder as HabitRPG-CLI to add your User ID and API Key for HabitRPG. This can be found in the settings area of your account on the [HabitRPG][1] site. + + [HabitRPGSettings] + UID= + APIKey= + Usage ----- HabitRPG-CLI accepts 3 parameters, 2 required and 1 optional: @@ -30,14 +46,6 @@ To give yourself a bonus for the "Productivity" habit and send a custom message: If you're indulging your bad browsing habits: `habitrpg Browsing down` - -Configuration -------------- -You will need to edit the "habitrpg.ini" file in the same folder as HabitRPG-CLI to add your User ID and API Key for HabitRPG. This can be found in the settings area of your account on the [HabitRPG][1] site. - - [HabitRPGSettings] - UID= - APIKey= Why? ---- @@ -90,4 +98,4 @@ This application uses several libraries written by others for AutoIT: [6]: http://www.autoitscript.com/forum/topic/95141-growl-for-windows-udf/ (Growl for Windows UDF) [7]: https://code.google.com/p/autoit-winhttp/ (WinHTTP wrapper for AutoIt) [8]: http://markus.mohnen.net/ (Markus Mohnen) -[9]: http://gmailgrowl.blogspot.com/ (Gmail Growl) \ No newline at end of file +[9]: http://gmailgrowl.blogspot.com/ (Gmail Growl)