Some tweaks to documentation / readme

Author: bryphe

INDEX.md

@@ -0,0 +1,21 @@
+# Oni API
+
+This documents the surface area of Oni's API, which is available to both _plugins_ and _configuration_.
+
+A good starting point is the [Plugin API](interfaces/plugin.api.html), which is the object passed into the `activate` methods.
+
+An example `config.js` using the API object is:
+
+```
+const activate = (oni) => {
+    // The passed in `oni` object is an instance of the Plugin API
+}
+
+module.exports = {
+    activate,
+}
+```
+
+Likewise, for a plugin, the entry point is an `activate` method with a [Plugin API](interfaces/plugin.api.html) object passed in.
+
+

README.md

@@ -3,4 +3,12 @@
 [![npm version](https://badge.fury.io/js/oni-api.svg)](https://badge.fury.io/js/oni-api)
 
 # oni-api
-Oni's extensibility model API
+
+Oni's extensibility model API, along with auto-generated documentation.
+
+The latest documentation is available [here](https://onivim.github.io/oni-api).
+
+## Build
+
+- `npm install`
+- `npm run build`

package.json

@@ -6,7 +6,7 @@
   "types": "lib/index.d.ts",
   "scripts": {
     "build:src": "rimraf lib && tsc",
-    "build:docs": "typedoc --out docs src/index.ts --mode file",
+    "build:docs": "typedoc --out docs src/index.ts --mode file --readme INDEX.md",
     "build": "npm run build:src && npm run build:docs",
     "test": "echo \"Error: no test specified\" && exit 1"
   },