Update readme.md

readme.md

@@ -1,6 +1,14 @@
-# XIVBar [Ported by Tirem]
+# XIVBar [Ported and Updated by Tirem]
+A player hp/mp/tp bar addon originally for Windower4 that I updated and ported to Ashita v4 <3
 
-***This addon was reworked and ported to Ashita v4 from Windower4**
+Original Windower4 addon by Edeon [https://github.com/Windower/Lua/tree/live/addons/xivbar]
+
+## Show Your Support ##
+If you would like to show your support for my addon creation and porting consider buying me (Tirem) a coffee! 
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A6JC40H)
+
+## Overview
 
 This addon displays vital bars for easy tracking
 
@@ -11,8 +19,17 @@ You can choose from 3 different styles 'ffxiv', 'ffxi' and 'ffxiv-legacy'.
 ![alt text](http://i.imgur.com/vMlZoAl.png)
 
 and you can use a compact version for a smaller resolution:
+
 ![alt text](http://i.imgur.com/0vgfDq1.png)
 
+## Installation
+* Download the latest release from the panel on the right. Please download the top option on the release page.
+* Extract the folder and drop the addons folder within into the install location of Ashita v4
+* Load using "/addon load xivbar" in the chat window
+* To load the addon automatically when the game starts, edit scripts/default.txt and add "/addon load xivbar" at the end
+* RECOMMENDED: Download and install the free font "[Grammara](https://www.fontspace.com/grammara-font-f4454)" for a more authentic FF14 look of the numbers (restart Ashita afterwards, or it won't find the newly installed font)
+* NOTE: You will NOT be able to load this addon if you download it from the CODE button above, as it relies on git submodules to function. Please always download from the release page on the right!
+
 ## Available Settings
 ##### Bars
 * **Offset X** - moves the entire addon left (negative number) or right (positive number) the given number of pixels
@@ -33,11 +50,12 @@ and you can use a compact version for a smaller resolution:
 * **DimTpBar** - dim the TP bar when not full
 
 ## How to edit the settings
+* You can directly edit most settings in the in game config (/xivbar, or /xb)
+* To edit these settings and more manually: 
 1. Login to your character in FFXI
 2. Edit the addon's settings file: **[GameInstallLocation]\config\addons\xivbar\settings.lua**
 3. Save the file 
 5. Type ``` /addon reload xivbar ``` to reload the addon
-6. *This method will soon be replaced by a config menu*
 
 ## How to create my own custom theme
 1. Create a folder inside the *theme* directory of the addon: **[GameInstallLocation]\addons\xivbar\themes\MY_CUSTOM_THEME**