Skip to content

Commit

Permalink
convert README to rdoc and bump version number
Browse files Browse the repository at this point in the history
  • Loading branch information
pboling committed Aug 25, 2009
1 parent 055044c commit 4260b2a
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 21 deletions.
20 changes: 7 additions & 13 deletions README → README.rdoc
Original file line number Diff line number Diff line change
@@ -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):
Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Intridea, Inc. (http://www.intridea.com/). Released under the MIT license
1 change: 0 additions & 1 deletion VERSION

This file was deleted.

4 changes: 4 additions & 0 deletions VERSION.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
:major: 0
:minor: 2
:patch: 0
12 changes: 5 additions & 7 deletions subdomain-fu.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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.}
Expand Down

0 comments on commit 4260b2a

Please sign in to comment.