updated readme

Solvaring [07-08-17 - 22:22]
updated readme
Filename
README.md
diff --git a/README.md b/README.md
index 130bd1c..5825ea0 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 I have wrapped this whole project into a plugin for ZBS, you can simply take ZBS_API_FILES/ESOXMLPlugin.lua and drop it into your packages directory of ZBS. If you ever need to update the api and I'm away from the game for a while, use the scripts described below to help you build a new api definition from the dump file. You can drop the lua api file into your api directory and link through user.lua config file, but if you want to update xml keywords and attributes as well, the process is still fairly simple and straightforward.

 Generate the lua api with the script, open the resulting file and change the line that has ` return { ` to
-` local api = { ` open up your plugin file and copy paste it right over the old api block, make sure the entire old api block is wiped out first. Then use the xmlapicreator2.lua to generate a list of xml keywords. Scroll down in your plugin file to the onRegister function. Copy and paste all the keywords from the file that xmlapicreator2 created over the old block of keywords, you can't miss it. The line says ` local keywords = self:GetConfig().keywords or [[ huge block of keywords here ]] `
+` local api = { ` open up your plugin file (ESOAPIXMLPlugin.lua) and copy paste it right over the old api block, make sure the entire old api block is wiped out first. Then use the xmlapicreator2.lua to generate a list of xml keywords. Scroll down in your plugin file to the onRegister function. Copy and paste all the keywords from the file that xmlapicreator2 created over the old block of keywords, you can't miss it. The line says ` local keywords = self:GetConfig().keywords or [[ huge block of keywords here ]] `

 That's all there is to it, just generate lua api file, xml keywords, make an edit to the generated lua api file and then copy paste it all over the parts in the plugin that need replacing. Happy developing everyone!!!

@@ -10,9 +10,9 @@ Script to build an api definition file from the dump file provided at esoui in t

 **There is a second branch called 'closingbrace' after running that branch's code for apimaker there will be only one '},' that needs to be moved to the very end of the file. There are now updated instructions if you switch to that branch, I found the bug and give instruction on how to fix the line that didn't properly close a table. I do believe that this is now a quicker and easier way to generate a lua api definition file. Go check it out!**

-The two main files you will need for this script to build an autocomplete for the lua api are **apimaker2.lua** and **ESOUIDocumentation.txt**. To build an autocomplete definition for the xml keywords you will need **esouixml.txt** and **xmlapicreator2.lua". Please note that as of this release, the xml portion is not finished yet but is coming soon.
+The two main files you will need for this script to build an autocomplete for the lua api are **apimaker2.lua** and **ESOUIDocumentation.txt**. To build an autocomplete definition for the xml keywords you will need **esouixml.txt** and **xmlapicreator2.lua". If you want to have support for xml keywords you will need to use the plugin explained above. If for some reason you aren't using the plugin you will only have Lua API ZBS compliant file to be put into the api/ directory of zbs.

-If you want to use this to add autocomplete functionality to your Zerobrane Studio just drop ESOAPI.lua and ESOXML.lua into /api/lua of your ZBS directory and then use the normal linking procedure through ZBS user.config or modification of an interpreter file. The final versions of these files ready to be dropped into your api directory are located in ZBS_API_Files
+If you want to use this to add autocomplete functionality to your Zerobrane Studio just drop ESOAPI.lua into /api/lua of your ZBS directory and then use the normal linking procedure through ZBS user.config or modification of an interpreter file. The final versions of this file is ready to be dropped into your api directory are located in ZBS_API_Files, the plugin is also located in that directory.

 Updated API maker but the regex is sloppy and the file produced has some errant brackets and commas floating around. I cleaned it up with find and replace in notepad plus plus and am committing the cleaned up and working api definition file as ESOAPI.lua