README.md in percheron-0.6.4 vs README.md in percheron-0.7.0
- old
+ new
@@ -4,12 +4,10 @@
[![Build Status](https://travis-ci.org/ashmckenzie/percheron.svg?branch=master)](https://travis-ci.org/ashmckenzie/percheron)
[![Code Climate GPA](https://codeclimate.com/github/ashmckenzie/percheron/badges/gpa.svg)](https://codeclimate.com/github/ashmckenzie/percheron)
[![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)
-![Percheron](https://raw.githubusercontent.com/ashmckenzie/percheron/master/assets/percheron.png)
-
Organise your Docker containers with muscle and intelligence.
## Installation
Add this line to your application's Gemfile:
@@ -28,12 +26,30 @@
```shell
$ gem install percheron
```
+## Requirements
+
+* Ruby 2.x
+* Docker 1.6.x
+
## Usage
-WIP, not ready yet :)
+TODO
+
+## Examples
+
+* Rails - https://github.com/ashmckenzie/percheron-rails#quickstart
+* Torrent - https://github.com/ashmckenzie/percheron-torrent#quickstart
+
+## Testing
+
+All (cane, RuboCop, unit and integration):
+
+```shell
+bundle exec test
+```
## Contributing
1. Fork it ( https://github.com/ashmckenzie/percheron/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)