Update README

Author: HybridEidolon

README.md

@@ -1,5 +1,37 @@
 # BB UI addons plugin
 
+[![Build status](https://ci.appveyor.com/api/projects/status/w21j2rcek9g9v8vv/branch/master?svg=true)](https://ci.appveyor.com/project/HybridEidolon/psobbaddonplugin/branch/master)
+
+A plugin for Phantasy Star Online Blue Burst that enables graphical UI addons,
+which can read the game's memory and present additional useful information.
+
+- [Wiki](https://github.com/HybridEidolon/psobbaddonplugin/wiki)
+- [Releases](https://github.com/HybridEidolon/psobbaddonplugin/releases)
+
+## Installation
+
+1. Download the latest release from the [Releases](https://github.com/HybridEidolon/psobbaddonplugin/releases) page
+and extract the zip contents to your PSOBB directory.
+2. Install the [Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-us/download/details.aspx?id=48145).
+3. Run the game.
+
+## Building and Testing
+
+To test the lua code, install luacheck and busted from luarocks and
+
+    $ luacheck addons
+    $ busted
+
+To build the plugin dll, use Visual Studio 2015.
+
+## Usage
+
+Press the \` key to open the Main Menu of the addon.
+
+## Changelog
+
+See CHANGELOG.md for more info
+
 **The API is completely unstable for now, expect it to change.**
 
 ImGui is exposed via the `imgui` module, which is in the global environment as `imgui`.
@@ -20,3 +52,4 @@ PSO specific functions are in the `pso` global table.
  * read_wstr(addr, len) -- read utf16 str to utf8 at address with len characters, or double null terminated (0 len)
  * read_mem(table, addr, len) -- read len bytes from addr into table. the table should be initialized as empty, i.e. `local table = {}; pso.read_mem(table, 0x00400000, 0x7fffffff-0x00400000)` (don't read the entire address space, that's silly and will probably kill the process)
  * reload() -- at the end of present, re-initialize the lua state. all addons and modules will be reloaded, no state will be preserved.
+ * base_address -- the base address of the PSOBB process