README.md in fourchette-0.0.7 vs README.md in fourchette-0.0.8
- old
+ new
@@ -4,40 +4,41 @@
</a>
<br />
<b>Your new best friend for isolated testing environments on Heroku</b>
<br />
<a href="https://codeclimate.com/github/jipiboily/fourchette"><img src="https://codeclimate.com/github/jipiboily/fourchette.png" /></a>
- <a href="https://github.com/jipiboily/fourchette"><img src="https://travis-ci.org/jipiboily/fourchette.png?branch=master" /></a>
+ <a href="https://travis-ci.org/jipiboily/fourchette"><img src="https://travis-ci.org/jipiboily/fourchette.png?branch=master" /></a>
<a href='https://coveralls.io/r/jipiboily/fourchette'><img src='https://coveralls.io/repos/jipiboily/fourchette/badge.png' alt='Coverage Status' /></a>
<a href="http://badge.fury.io/rb/fourchette"><img src="https://badge.fury.io/rb/fourchette.svg" alt="Gem Version" height="18"></a>
</p>
Fourchette is your new best friend for having isolated testing environements. It will help you test your GitHub PRs against a fork of one your Heroku apps. You will have one Heroku app per PR now. Isn't that amazing? It will make testing way easier and you won't have the (maybe) broken code from other PRs on staging but only the code that requires testing.
**IMPORTANT: Please note that forking your Heroku app means it will copy the same addon plans and that you will pay for multiple apps and their addons. Watch out!**
## Table of content
-1. How does that work exactly?
-- Features
-- Installation
- * Configuration
- * Enable your Fourchette instance
- * Enable, disable, update or delete the hook
- * Before & after steps, aka, callbacks
-- Rake tasks
-- Async processing note
-- Contribute
- - Logging
-- Contributors
+1. [How does that work exactly?](#how-does-that-work-exactly)
+- [Installation](#installation)
+ * [Configuration](#configuration)
+ * [Enable your Fourchette instance](#enable-your-fourchette-instance)
+ * [Enable, disable, update or delete the hook](#enable-disable-update-or-delete-the-hook)
+ * [Before & after steps, aka, callbacks](#before--after-steps-aka-callbacks)
+- [Rake tasks](#rake-tasks)
+- [Async processing note](#async-processing-note)
+- [Contribute](#contribute)
+ - [Logging](#logging)
+- [Contributors](#contributors)
## How does that work exactly?
- a PR is created against your GitHub project
- Fourchette receives an event via GitHub Hooks
- it [forks](https://devcenter.heroku.com/articles/fork-app) an environement making it available to you
- any new commit against that PR will update the code
- closing the PR will delete the forked app
- re-opening the PR will re-create a fork
+
+We use it a lot at [Rainforest QA](https://www.rainforestqa.com/). If you want to see a sample Fourchette app, here is one for you to look at: https://github.com/rainforestapp/fourchette.
## Installation
1. run `gem install fourchette`
2. run `fourchette new my-app-name`. You can replace "my-app-name" by whatever you want it, this is the name of the directory your Fourchette app will be created in.