README.md in percheron-0.7.1 vs README.md in percheron-0.7.2
- old
+ new
@@ -6,10 +6,25 @@
[![Test Coverage](https://codeclimate.com/github/ashmckenzie/percheron/badges/coverage.svg)](https://codeclimate.com/github/ashmckenzie/percheron)
[![Dependency Status](https://gemnasium.com/ashmckenzie/percheron.svg)](https://gemnasium.com/ashmckenzie/percheron)
Organise your Docker containers with muscle and intelligence.
+## Features
+
+* Single, easy to write `.percheron.yml` controls everything
+* Supports building, creating and starting of containers and their dependancies
+* Supports building using a Dockerfile or pulling a Docker image from Docker Hub
+* Build 'base' images as a dependancy and then build from there
+* Support for pre-build and post-start scripts when generating images and starting containers
+* Version control of building images and containers
+* Written in Ruby :)
+
+## Supported platforms
+
+* Linux
+* MacOS 10.9+
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -29,39 +44,40 @@
```
## Requirements
* Ruby 2.x
-* Docker 1.6.x
+* [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
## Examples
-* Rails - https://github.com/ashmckenzie/percheron-rails#quickstart
-* Torrent - https://github.com/ashmckenzie/percheron-torrent#quickstart
-* SaltStack - https://github.com/ashmckenzie/percheron-saltstack#quickstart
+* [Rails](https://github.com/ashmckenzie/percheron-rails#quickstart) - Rails 4.2, PostgreSQL, redis, HAProxy and postfix
+* [Torrent](https://github.com/ashmckenzie/percheron-torrent#quickstart) - Tracker (chihaya), seeder (aria2) and three peers (aria2)
+* [SaltStack](https://github.com/ashmckenzie/percheron-saltstack#quickstart) - SaltStack v2015.2.0rc2 with master and minion
## Testing
All (cane, RuboCop, unit and integration):
```shell
-bundle exec test
+bundle exec rake test
```
Style (cane and RuboCop):
```shell
-bundle exec test:style
+bundle exec rake test:style
```
-
## Contributing
1. Fork it ( https://github.com/ashmckenzie/percheron/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+4. Run `bundle exec rake test`
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request