README file

Gemfile.lock

@@ -8,42 +8,49 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aruba (0.6.2)
-      childprocess (>= 0.3.6)
-      cucumber (>= 1.1.1)
-      rspec-expectations (>= 2.7.0)
+    aruba (0.9.0)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
     builder (3.2.2)
-    childprocess (0.5.5)
+    childprocess (0.5.6)
       ffi (~> 1.0, >= 1.0.11)
-    cucumber (1.3.19)
+    contracts (0.11.0)
+    cucumber (2.1.0)
       builder (>= 2.1.2)
+      cucumber-core (~> 1.3.0)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 2.12)
+      gherkin3 (~> 3.1.0)
       multi_json (>= 1.7.5, < 2.0)
       multi_test (>= 0.1.2)
+    cucumber-core (1.3.0)
+      gherkin3 (~> 3.1.0)
     diff-lcs (1.2.5)
-    ffi (1.9.6)
-    gherkin (2.12.2)
-      multi_json (~> 1.3)
+    ffi (1.9.10)
+    gherkin3 (3.1.1)
     git (1.2.9)
     gli (2.12.2)
-    multi_json (1.10.1)
+    multi_json (1.11.2)
     multi_test (0.1.2)
     rake (10.4.2)
     rdoc (4.2.0)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.0)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.1)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    thor (0.19.1)
 
 PLATFORMS
   ruby
@@ -55,3 +62,6 @@ DEPENDENCIES
   rdoc
   redbutton!
   rspec
+
+BUNDLED WITH
+   1.10.6

README.md

@@ -0,0 +1,39 @@
+# The Red Button™
+
+## How to use it
+
+The project at the moment is not yet extracted in a gem, so we need to stick to this list of instructions.
+
+### 1. make sure you have AM_PATH variable correctly set up to point to root of the AM project on your machine
+```
+export AM_PATH=/home/elod/ads_manager
+```
+
+### 2. be sure to be on the AM's develop branch 
+```
+cd $AM_PATH
+git checkout develop
+git pull
+git flow release start x.y.z
+```
+
+### 3. back to the redbutton project
+```
+cd -
+```
+
+### 4. bump up the version
+```
+bundle exec redbutton --project_path=$AM_PATH --release_notes_folder=release-notes --version_file=config/initializers/version.rb bump_version
+```
+
+### 5. create release notes
+```
+bundle exec redbutton --project_path=$AM_PATH --release_notes_folder=release-notes --version_file=config/initializers/version.rb create_release_notes
+```
+
+### 6. you can now create a new release with git flow
+```
+cd $AM_PATH
+git flow release finish x.y.z
+```