change: added doc of how to load plugin.

.gitignore

@@ -43,3 +43,4 @@ luac.out
 logs
 t/servroot
 go
+\.*

README.md

@@ -1 +1,21 @@
-# apimeta
+# Summary
+
+# Design Doc
+
+### How to load the plugin?
+
+![](doc/flow-load-plugin.png)
+
+### Plugin
+
+![](doc/flow-plugin-internal.png)
+
+
+# Development
+
+### Source Install
+
+> Dependent library
+
+* Setups the [resty-r3#install](https://github.com/iresty/lua-resty-r3#install) library.
+

conf/config.yaml

@@ -2,3 +2,6 @@ etcd:
   host: "http://127.0.0.1:2379"
   prefix: "/v2/keys"
   timeout: 60
+
+plugins:
+  - example_plugin

lua/apimeta/comm/config.lua

@@ -15,7 +15,7 @@ local function read_file(path)
         return nil
     end
 
-    local content = file:read("*a") -- *a or *all reads the whole file
+    local content = file:read("*a") -- `*a` reads the whole file
     file:close()
     return content
 end

t/yaml-config.t

@@ -15,12 +15,15 @@ __DATA__
         content_by_lua_block {
             local encode_json = require "cjson.safe" .encode
             local config = require("apimeta.comm.config").read()
+
             ngx.say("etcd host: ", config.etcd.host)
             ngx.say("etcd prefix: ", config.etcd.prefix)
+            ngx.say("plugins: ", encode_json(config.plugins))
         }
     }
 --- request
 GET /t
 --- response_body
 etcd host: http://127.0.0.1:2379
 etcd prefix: /v2/keys
+plugins: ["example_plugin"]