Default redirect to version 5.1.1
[cordova-labs.git] / README.md
index 0a51d7496a8e83bdc93f610a8507b7840506abff..3c18a3a6e8a6f04e085723e0a1fc9bba2db64753 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,46 @@
-# Cordova Laboratory
+# Cordova Documentation Redirect Server
 
-> Caution: Safety Goggles are Recommended!
+## Redirect Logic
+
+    Request      |  Type  |  Redirect
+    -------------|--------|----------------
+    /            |  302   |  /en/VERSION/index.html
+    /some/path/  |  302   |  /some/path/
+
+## Contribute
+
+### Install
+
+1. Install [Heroku Toolkit](https://toolbelt.heroku.com/)
+1. `$ npm install`
+
+### Updating Homepage Version
+
+    $ echo 2.5.0 > VERSION
+    $ git commit -am "Default redirect to version 2.5.0"
+
+### Start Server
+
+    $ npm start
+
+### Deploy to Heroku
+
+    # Sanity test that Heroku Procfile works
+    $ foreman start
+
+    # Add Heroku remote repository
+    $ git remote add heroku git@heroku.com:docs-cordova-io.git
+
+    # Heroku must deploy from master branch
+    $ git push heroku docs-cordova-io:master
+
+## Heroku Details
+
+- 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>
+
+To become a collaborator to the Heroku project:
+
+- Sign up for a [Heroku account](http://heroku.com)
+- Email dev@cordova.apache.org and provide your Heroku account