README.rdoc in rewritten-0.1.0 vs README.rdoc in rewritten-0.2.0
- old
+ new
@@ -7,17 +7,18 @@
If a matching translation is found, the result of a request is either a
redirection or a modification of path and request parameters. For URLs
without translation entries the request is left unmodified.
Rewritten takes larges parts from the Resque codebase (which rocks). The
-gem is compromised of four parts:
+gem is compromised of six parts:
1. A Ruby library for creating, modifying and querying translations
2. A Sinatra app for displaying and managing translations
-3. A Rack app for rewriting and redirecting request (Rack::Rewritten::Url)
-4. A Rack app for substituting URLs in HTML pages with their current translation (Rack::Rewritten::Html)
-5. A Rack app for recording successful request (Rack::Rewritten::Record)
+3. A Rack app for identifying subdomains (Rack::Rewritten::Subdomain)
+4. A Rack app for rewriting and redirecting request (Rack::Rewritten::Url)
+5. A Rack app for substituting URLs in HTML pages with their current translation (Rack::Rewritten::Html)
+6. A Rack app for recording requests (Rack::Rewritten::Record)
== New Relic Notice
There seem to be unresolved issues when Rack::Rewritten::Html is used
@@ -41,12 +42,13 @@
Rewritten.remove_translation('/apple-computer/newton', '/products/4e4d3c6a1d41c811e8000009')
== Usage in your Rack stack
-To take full advantage of the engine you would use both, the URL and
-HTML, rack apps as follows:
+To take full advantage of the engine you would be using at least
+the following stack:
+ use Rack::Rewritten::Subdomain, "example.com", "lvh.me" # only needed for subdomain support
use Rack::Rewritten::Url
use Rack::Rewritten::Html
run Your::App
This way the URL rewriting and generation is stays decoupled from your