Default redirect to version 5.1.1
[cordova-labs.git] / README.md
index ec7d3450888da08255a93a78396f4ad44e07fa38..3c18a3a6e8a6f04e085723e0a1fc9bba2db64753 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,40 +1,46 @@
 # Cordova Documentation Redirect Server
 
-## Redirects
+## Redirect Logic
 
-    Request        Redirect
-    ---------------------------------------
-    /            |  /en/VERSION/index.html
-    /some/path/  |  /some/path/
+    Request      |  Type  |  Redirect
+    -------------|--------|----------------
+    /            |  302   |  /en/VERSION/index.html
+    /some/path/  |  302   |  /some/path/
 
-## Setup
+## Contribute
 
-### DNS
+### Install
 
-__Name:__ `docs.cordova.io`
+1. Install [Heroku Toolkit](https://toolbelt.heroku.com/)
+1. `$ npm install`
 
-__Url:__ `http://mwbrooks.redirect-docs-cordova-io.jit.su`
+### Updating Homepage Version
 
-__Redirect Type:__ 302
+    $ echo 2.5.0 > VERSION
+    $ git commit -am "Default redirect to version 2.5.0"
 
-### Hosting
+### Start Server
 
-__Service:__ [Nodejitsu](http://nodejitsu.com)
+    $ npm start
 
-__Account:__ mwbrooks (Michael Brooks)
+### Deploy to Heroku
 
-__URL:__ [http://mwbrooks.redirect-docs-cordova-io.jit.su/](http://mwbrooks.redirect-docs-cordova-io.jit.su/)
+    # Sanity test that Heroku Procfile works
+    $ foreman start
 
-## Usage
+    # Add Heroku remote repository
+    $ git remote add heroku git@heroku.com:docs-cordova-io.git
 
-### Deployment
+    # Heroku must deploy from master branch
+    $ git push heroku docs-cordova-io:master
 
-    $ jitsu deploy
+## Heroku Details
 
-### Updating Default Version
+- Project: [docs-cordova-io](https://dashboard.heroku.com/apps/docs-cordova-io/resources)
+- Git Repo: [git@heroku.com:docs-cordova-io.git](git@heroku.com:docs-cordova-io.git)
+- Owner: Michael Brooks <michael@michaelbrooks.ca>
 
-    $ echo 2.5.0 > VERSION
-
-    $ git commit -am "Default redirect to version 2.5.0"
+To become a collaborator to the Heroku project:
 
-    $ jitsu deploy
+- Sign up for a [Heroku account](http://heroku.com)
+- Email dev@cordova.apache.org and provide your Heroku account