README.md in percheron-0.7.6 vs README.md in percheron-0.7.7

- old
+ new

@@ -49,20 +49,65 @@ * [Docker 1.6.x](https://docs.docker.com/installation/) / [Boot2Docker v1.6.x+](https://docs.docker.com/installation) * [Docker client](https://docs.docker.com/installation) (nice to have) ## Usage -TODO +1) Install percheron +```bash +gem install percheron +``` + +2) Create a `.percheron.yml` file describing your stack: + +```yaml +--- +docker: + host: "https://boot2docker:2376" + ssl_verify_peer: false + +stacks: + - name: consul + units: + - name: master + version: 1.0.0 + docker_image: progrium/consul:latest + start_args: "-server -bootstrap -ui-dir /ui" + ports: + - "8500:8500" + - name: agent + version: 1.0.0 + docker_image: progrium/consul:latest + start_args: "-server -join master" + dependant_unit_names: + - master +``` + +3) Start it up! + +```bash +percheron start demo +``` + +4) Bring up the consul UI + +```bash +open http://boot2docker:8500/ui +``` + ## Demo [![asciicast](https://asciinema.org/a/19216.png)](https://asciinema.org/a/19216) ## Debugging -To debug Percheron, set the `DEBUG=true` environment variable. +To perform debugging you will need to install the `pry-byebug` gem: -To debug Percheron and Docker, set the `DOCKER_DEBUG=true` environment variable. +```bash +gem install pry-byebug +``` + +To debug Percheron, set the `DEBUG=true` environment variable. To debug Percheron and Docker, set the `DOCKER_DEBUG=true` environment variable. ## Examples * [Rails](https://github.com/ashmckenzie/percheron-rails#quickstart) - Rails 4.2, PostgreSQL, redis, HAProxy and postfix * [Redis](https://github.com/ashmckenzie/percheron-redis#quickstart) - Redis cluster + sentinel, master, two slaves and tools