Update README.md

README.md

@@ -16,6 +16,63 @@ orbiter daemon
 ```
 Orbiter is a daemon that exposes an HTTP API to trigger scaling up or down.
 
+
+Public and private cloud or different technologies like virtual machine or containers. Our applications and our environments require to be resilient doesn't matter where they are or which services are you using.
+
+This project is a work in progress cross platform open source autoscaler.
+
+We designed in collaboration with InfluxData to show how metrics can be used.
+
+It is based on plugins called provider. At the moment we implemented:
+
+- Docker Swarm mode (go to zero-conf chapter. look full example under ./contrib/swarm directory
+- DigitalOcean
+
+```bash
+orbiter daemon -config config.yml
+```
+
+Orbiter is a daemon that use a YAML configuration file to starts one or more autoscaler and it exposes an HTTP API to trigger scaling up or down.
+
+```yml
+autoscalers:
+  events:
+    provider: swarm
+    parameters:
+    policies:
+      php:
+        up: 4
+        down: 3
+  infra_scale:
+    provider: digitalocean
+    parameters:
+      token: zerbzrbzrtnxrtnx
+      region: nyc3
+      size: 512mb
+      image: ubuntu-14-04-x64
+      key_id: 163422
+      # https://www.digitalocean.com/community/tutorials/an-introduction-to-cloud-config-scripting
+      userdata: |
+        #cloud-config
+
+        runcmd:
+          - sudo apt-get update
+          - wget -qO- https://get.docker.com/ | sh
+    policies:
+      frontend:
+        up: 2
+        down: 3
+```
+This is an example of configuration file. Right now we are creating two autoscalers one to deal with swarm called events/php and the second one with DigitalOcean called infra_scale.
+
+Vocabulary
+provider contains integration with the platform to scale. It can be swarm, DigitalOcean, OpenStack, AWS.
+Every autoscaler supports a k\v storage of parameters that you can use to configure your provider.
+autoscaler` is composed by provider, parameters and policies. You can have one or more.
+autoscaler has only or more policies they contains information about a specific application.
+You can have only one autoscaler or more with th same provider. Same for policies, only one or more. Doesn't matter.
+
+
 ## Http API
 Orbiter exposes an HTTP JSON api that you can use to trigger scaling UP (true)
 or DOWN (false).