From 252e9e70ae8c04e84ae85c443e0f3631fe717333 Mon Sep 17 00:00:00 2001
From: Matthieu Moquet <matthieu@moquet.net>
Date: Sat, 6 Dec 2014 23:27:46 +0100
Subject: [PATCH] Add README file

---
 .gitignore                                 |  2 +-
 README.md                                  | 28 ++++++++++++++++++++++
 stages/{deploy.rb.dist => example.rb.dist} |  0
 3 files changed, 29 insertions(+), 1 deletion(-)
 create mode 100644 README.md
 rename stages/{deploy.rb.dist => example.rb.dist} (100%)

diff --git a/.gitignore b/.gitignore
index 1646dc4..b275691 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,3 @@
 /stages/*
-!/stages/deploy.rb.dist
+!/stages/example.rb.dist
 /vendor/*
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c7be815
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# OpenLocalization Capistrano
+
+Configuration files to deploy the [openl10n](https://github.com/openl10n/openl10n) project
+using [Capistrano](http://capistranorb.com/).
+
+## Install
+
+```bash
+gem install bundler
+bundle install
+```
+
+## Configure
+
+Copy the `stages/example.rb.dist` file and adapt it to your need.
+For instance, create a `production` environment:
+
+```bash
+cp stages/example.rb.dist stages/production.rb
+```
+
+## Deploy
+
+Deploy to this production environment:
+
+```bash
+bundle exec cap production deploy
+```
diff --git a/stages/deploy.rb.dist b/stages/example.rb.dist
similarity index 100%
rename from stages/deploy.rb.dist
rename to stages/example.rb.dist