diff --git a/README b/README.rdoc similarity index 94% rename from README rename to README.rdoc index ec5bc22..dd52c2e 100644 --- a/README +++ b/README.rdoc @@ -1,13 +1,11 @@ -SubdomainFu -=========== += SubdomainFu 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. -Installation -============ +== Installation SubdomainFu is available both as a traditional plugin and a GemPlugin. To install it as a traditional plugin (Rails 2.1 or later): @@ -19,8 +17,7 @@ To use it as a GemPlugin, add it to your environment.rb: config.gem 'mbleigh-subdomain-fu', :source => "http://gems.github.com", :lib => "subdomain-fu" -Examples -======== +== 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 @@ -48,8 +45,7 @@ users_path(:subdomain => false) # => /users In this way you can rest assured that you will never misdirect your links to the same subdomain when you meant to change it. -Configuration -============= +== Configuration You may need to configure SubdomainFu based on your development setup. The configuration required is: @@ -84,19 +80,17 @@ SubdomainFu.preferred_mirror = "www" Now when you create a link to a false subdomain -Known Issues / Future Work -========================== +== Known Issues / Future Work SubdomainFu will eventually integrate with Rails' routing internals to provide the ability to specify routes based on the condition of a specific subdomain or simply whether a subdomain is present (or a mirror). -Resources -========= +== Resources * Acts As Community Project: http://actsascommunity.com/projects/subdomain-fu * GitHub Repository: http://github.com/mbleigh/subdomain-fu * Lighthouse: http://mbleigh.lighthouseapp.com/projects/13148-subdomain-fu Copyright (c) 2008 Michael Bleigh (http://www.mbleigh.com/) and -Intridea, Inc. (http://www.intridea.com/). Released under the MIT license \ No newline at end of file +Intridea, Inc. (http://www.intridea.com/). Released under the MIT license diff --git a/VERSION b/VERSION deleted file mode 100644 index 6e8bf73..0000000 --- a/VERSION +++ /dev/null @@ -1 +0,0 @@ -0.1.0 diff --git a/VERSION.yml b/VERSION.yml new file mode 100644 index 0000000..38e2d1c --- /dev/null +++ b/VERSION.yml @@ -0,0 +1,4 @@ +--- +:major: 0 +:minor: 2 +:patch: 0 diff --git a/subdomain-fu.gemspec b/subdomain-fu.gemspec index 2caaf8c..ad60e8f 100644 --- a/subdomain-fu.gemspec +++ b/subdomain-fu.gemspec @@ -2,22 +2,21 @@ Gem::Specification.new do |s| s.name = %q{subdomain-fu} - s.version = "0.1.0" + s.version = "0.2.0" s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= s.authors = ["Michael Bleigh"] s.date = %q{2009-05-26} s.description = %q{SubdomainFu is a Rails plugin to provide all of the basic functionality necessary to handle multiple subdomain applications (such as Basecamp-esque subdomain accounts and more).} s.email = %q{michael@intridea.com} - s.extra_rdoc_files = [ - "README" - ] + s.has_rdoc = true + s.rdoc_options = ["--charset=UTF-8"] s.files = [ "CHANGELOG", "MIT-LICENSE", - "README", + "README.rdoc", "Rakefile", - "VERSION", + "VERSION.yml", "lib/subdomain-fu.rb", "lib/subdomain_fu/routing_extensions.rb", "lib/subdomain_fu/url_rewriter.rb", @@ -28,7 +27,6 @@ Gem::Specification.new do |s| "spec/url_rewriter_spec.rb" ] s.homepage = %q{http://github.com/mbleigh/subdomain-fu} - s.rdoc_options = ["--charset=UTF-8"] s.require_paths = ["lib"] s.rubygems_version = %q{1.3.3} s.summary = %q{SubdomainFu is a Rails plugin that provides subdomain routing and URL writing helpers.}