add docs

apigee-internal · Mar 15, 2016 · fb3bb33 · fb3bb33
1 parent 0d8c877
commit fb3bb33
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# Microgateway 
+The Microgateway is composed of 4 components
+
+* microgateway-core: a lightweight core server that forwards requests and responses between northbound and southbound endpoints.  Core also contains an event model that will call each plugin.    
+* microgateway-config: a config module that allows a user to pull down and load yaml configs from Apigee Edge
+* microgateway-plugins: a file system reference to a collection of directories that allow a user to extend the microgateway.  
+* microgateway-cli: a command line driven runtime that will download the configuration, instantiate the plugins and run the microgateway-core. This component contains knowledge about where things are.  
+
+
+
+![microgateway](microgateway.png)
+
+![micro-flow](micro-flow.png)
+
+
+
diff --git a/micro-flow.png b/micro-flow.png
diff --git a/microgateway.png b/microgateway.png
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "microgateway-agent",
+  "name": "microgateway-cli",
   "version": "0.1.0",
   "description": "Management Agent for Edge Micro",
   "author": "shawnfeldman",