README update, demo

Author: emcniece

.gitignore

@@ -7,4 +7,5 @@ gsyncd.iml
 build
 .env
 /Godeps
-/vendor
+/vendor
+/demo

README.md

@@ -51,8 +51,50 @@ make dev-image
 make image
 ```
 
+## Demo
+
+The [docker-compose.yml](/docker-compose.yml) details a setup with a server and 2 clients. It will create a `./demo/` directory with 3 subfolders: `server`, `client1`, and `client2`. Each subfolder is volumed as `/share/` inside each container.
+
+As files in `./demo/server` are modified, they will be altered in `./demo/client1` and `./demo/client2`.
+
 Run Docker-Compose cluster:
 
 ```sh
 docker-compose up -d
-```
+```
+
+Check directories:
+
+```sh
+ls -al ./demo/server
+ls -al ./demo/client1
+ls -al ./demo/client2
+```
+
+Add a file to server volume:
+
+```sh
+echo "testing 123" > ./demo/server/test1
+```
+
+Check directories again:
+
+```sh
+ls -al ./demo/server
+ls -al ./demo/client1
+ls -al ./demo/client2
+```
+
+At this point, the `./demo/client*` directories should contain a `test1` file.
+
+## Notes
+
+### Docker Environment
+
+While the server configuration can be set to an IP of `0.0.0.0` (accepts traffic from anywhere), the clients need a specific address to connect to. If running locally, the clients can be set to connect to `127.0.0.1` - but this will not work in a Dockerized environment.
+
+The Docker-Compose.yml file contains `links: [fs-server:fs-server]` which enables the clients to contact the server container at `http://fs-server`. This is supported in a Rancher environment as well.
+
+### Rancher Environment
+
+- todo

docker-compose.yml

@@ -12,6 +12,8 @@ services:
     environment:
       FILESYNC_MODE: 'server'
       FILESYNC_PATH: '/share'
+    volumes:
+      - ./demo/server:/share
   fs-client1:
     image: "causticlab/filesync:dev"
     tty: true
@@ -27,6 +29,8 @@ services:
       FILESYNC_MODE: 'client'
       FILESYNC_IP: 'fs-server'
       FILESYNC_PATH: '/share'
+    volumes:
+      - ./demo/client1:/share
   fs-client2:
     image: "causticlab/filesync:dev"
     tty: true
@@ -41,4 +45,6 @@ services:
     environment:
       FILESYNC_MODE: 'client'
       FILESYNC_IP: 'fs-server'
-      FILESYNC_PATH: '/share'
+      FILESYNC_PATH: '/share'
+    volumes:
+      - ./demo/client2:/share