README.rdoc in subdomain-fu-0.5.4 vs README.rdoc in subdomain-fu-1.0.0.beta2

@@ -3,22 +3,24 @@
 SubdomainFu provides a modern implementation of subdomain handling in Rails.
 It takes aspects from account_location, request_routing, and other snippets
 found around the web and combines them to provide a single, simple solution
 for subdomain-based route and url management.
 
+**Note**: SubdomainFu has been rewritten to be compatible with Rails 3. If
+you are looking to use it on Rails 2.x, please install version v0.5.x instead.
+
 == Installation
 
 SubdomainFu is available both as a traditional plugin and a GemPlugin. To
-install it as a traditional plugin (Rails 2.1 or later):
+install it as a traditional plugin:
 
-  script/plugin install git://github.com/mbleigh/subdomain-fu.git
+  script/plugin install git://github.com/intridea/subdomain-fu.git
   
-To use it as a gem, add it to your config/environment.rb:
+To use it as a gem, add it to your Gemfile:
 
-  config.gem 'subdomain-fu'
+  gem 'subdomain-fu'
 
-
 == Examples
 
 SubdomainFu works inside of Rails's URL Writing mechanisms to provide an easy and seamless
 way to link and otherwise understand cross-subdomain routing. You can use the :subdomain
 option both in named and non-named routes as well as in generated resources routes.
@@ -49,62 +51,63 @@
 
 You have access to current_subdomain and current_domain methods.
 
 [current_subdomain] returns all subdomains. For the URL http://awesome.website.stuff.example.com, it will return "awesome.website.stuff"
 
-[current_domain] returns all subdomains except for the subdomain, including the TLD. For the URL http://awesome.website.stuff.example.com, it will return "website.stuff.example.com"
+[current_domain] returns the domain excluding for the subdomain, including the TLD. For the URL http://awesome.website.stuff.example.com, it will return "website.stuff.example.com"
 
 If what you really want is the entire domain, then use <tt>request.domain</tt> in
 your controllers.  The purpose of current_domain is to only strip off the first 
 subdomain, if any, and return what's left.
 
 == Configuration
 
-You may need to configure SubdomainFu based on your development setup. The
-configuration required is:
+You may need to configure SubdomainFu based on your development setup. To configure
+SubdomainFu simply call a block in an initializer like so:
 
-=== TLD Size
+    SubdomainFu.configure do |config|
+      config.option_name = value
+    end
 
+Some available options are enumerated below.
+
+=== tld_size
+
 A hash for each environment of the size of the top-level domain name. 
 (something.com = 1, localhost = 0, etc.)
 
-  SubdomainFu.tld_size = 1 # sets for current environment
-  SubdomainFu.tld_sizes = {:development => 0,
+  config.tld_size = 1 # sets for current environment
+  config.tld_sizes = {:development => 0,
                            :test => 0,
                            :production => 1} # set all at once (also the defaults)
                          
-=== Mirrors
+=== mirrors
 
 Mirrors are the subdomains that are equivalent to no subdomain (i.e. they 'mirror')
 the usage of the root domain.
 
-  SubdomainFu.mirrors = %w(www site we) # Defaults to %w(www)
+  config.mirrors = %w(www site we) # Defaults to %w(www)
 
-=== Preferred Mirror
+=== preferred_mirror
 
 SubdomainFu also understands the notion of a 'preferred mirror', that is, if you
 always want your links going to 'www.yourdomain.com' instead of 'yourdomain.com',
 you can set the preferred mirror like so:
 
-  SubdomainFu.preferred_mirror = "www"
+  config.preferred_mirror = "www"
 
 Now when you create a link with <tt>:subdomain => false</tt> in the options the subdomain
 will default to the preferred mirror.
 
-== Routing
+== Routing (Deprecated)
 
-SubdomainFu can also work within Rails' routing for subdomain-specific routes. For instance, if you only wanted your administrative tools available in the "admin" subdomain you could add this to your <tt>config/routes.rb</tt> file:
+Subdomain constraint routing has been removed from the scope of this plugin as Rails 3
+provides the functionality by default. For more info, see this blog post: 
+http://yehudakatz.com/2009/12/26/the-rails-3-router-rack-it-up/
 
-  map.with_options :conditions => {:subdomain => 'admin'} do |admin|
-    admin.resources :posts
-    admin.resources :users
-  end
-    
-In addition to specifying a string, you could also specify <tt>false</tt> to require no subdomain (this includes mirrors that you've set up such as www) or a regular expression to match a range of subdomains.
-
 == Resources
 
-* GitHub Repository: http://github.com/mbleigh/subdomain-fu
-* RDocs: http://rdoc.info/projects/mbleigh/subdomain-fu
+* GitHub Repository: http://github.com/intridea/subdomain-fu
+* RDocs: http://rdoc.info/projects/intridea/subdomain-fu
 
-Copyright (c) 2008 Michael Bleigh (http://www.mbleigh.com/) and 
+Copyright (c) 2008-2010 Michael Bleigh (http://www.mbleigh.com/) and 
 Intridea, Inc. (http://www.intridea.com/). Released under the MIT license