document the replace_canonical_subdomain option

matthewrobertson · Feb 26, 2013 · 1efb8b0 · 1efb8b0
1 parent c8642b8
commit 1efb8b0
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/lib/generators/ress/templates/ress.rb b/lib/generators/ress/templates/ress.rb
@@ -5,10 +5,16 @@
 
   # == Canonical Subdomain
   #
-  # If the cannonical version of your application is served under a subdomain
+  # If the canonical version of your application is served under a subdomain
   # you must set it here:
   #
   # config.set_canonical :subdomain => "subdomain"
+  #
+  # By default, alternate version subdomains are prepended to the canonical url.
+  # If you are using a canonical subdomain and you would like it to be replaced
+  # by the alternate subdomains, set this option to true:
+  #
+  # config.replace_canonical_subdomain = false
 
 
   # == Modernizr