Skip to content

Commit

Permalink
update README files
Browse files Browse the repository at this point in the history
  • Loading branch information
fortuity committed Feb 21, 2010
1 parent 4a72e37 commit 0ca34ee
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 22 deletions.
10 changes: 5 additions & 5 deletions README
@@ -1,22 +1,22 @@
# Subdomain-Authentication
Subdomain-Authentication

You can use this project as a starting point for any Rails web application that requires subdomains and authentication. User management and authentication is implemented using "Devise":http://github.com/plataformatec/devise. The "subdomain_routes":http://github.com/mholling/subdomain_routes/ gem implements subdomains and routing.

## Tutorial
Tutorial

A complete "walkthrough" tutorial is available on the GitHub wiki:

[Tutorial](http://wiki.github.com/fortuity/subdomain-authentication/)

This tutorial documents each step that you must follow to create this application.

## Use Cases
Use Cases

1) Administrators can visit the "admin" subdomain and view an administrative home page.
2) Visitors to the main application (without a subdomain) can register as users and create subdomains.
3) Any visitor can visit a subdomain and see a "site" home page.

## Assumptions
Assumptions

This tutorial is based on Rails version 2.3.5. Some of the code shown here will not work in older versions of Rails.

Expand All @@ -37,7 +37,7 @@ rails -v

You should have experience building a simple Rails application. Refer to http://guides.rubyonrails.org/ (Rails Guides) for help if you are a beginner.

## Create the Rails Application
Create the Rails Application

Open a terminal, navigate to a folder where you have rights to create files, and type:

Expand Down
26 changes: 9 additions & 17 deletions README.markdown
@@ -1,38 +1,30 @@
# Subdomain-Authentication

You can use this project as a starting point for any Rails web application that requires subdomains and authentication. User management and authentication is implemented using "Devise":http://github.com/plataformatec/devise. The "subdomain_routes":http://github.com/mholling/subdomain_routes/ gem implements subdomains and routing.
You can use this project as a starting point for any Rails web application that requires subdomains and authentication. User management and authentication is implemented using the [Devise](http://github.com/plataformatec/devise) gem. The [subdomain_routes](http://github.com/mholling/subdomain_routes/) gem implements subdomains and routing.

## Tutorial

A complete "walkthrough" tutorial is available on the GitHub wiki:

[Tutorial](http://wiki.github.com/fortuity/subdomain-authentication/)
[Tutorial](http://wiki.github.com/fortuity/subdomain-authentication/tutorial-walkthrough)

This tutorial documents each step that you must follow to create this application.
The tutorial documents each step that you must follow to create this application. Every step is documented concisely, so a complete beginner can create this application without any additional knowledge. However, no explanation is offered for any of the steps, so if you are a beginner, you’re advised to look for an introduction to Rails elsewhere.

## Use Cases

1) Administrators can visit the "admin" subdomain and view an administrative home page.
2) Visitors to the main application (without a subdomain) can register as users and create subdomains.
3) Any visitor can visit a subdomain and see a "site" home page.
1. Administrators can visit the "admin" subdomain and view an administrative home page.
2. Visitors to the main application (without a subdomain) can register as users and create subdomains.
3. Any visitor can visit a subdomain and see a "site" home page.

## Assumptions

This tutorial is based on Rails version 2.3.5. Some of the code shown here will not work in older versions of Rails.
This application requires Rails version 2.3.5. Some of the code shown here will not work in older versions of Rails.

This was written before the release of Rails 3.0. Things will change significantly in Rails 3.0 so this tutorial will be outdated when Rails 3.0 is released.
This application was written before the release of Rails 3.0. Things will change significantly in Rails 3.0 so this application will likely not work with Rails 3.0.

Before beginning this tutorial, you need to install
To use this application, you need to install

* The Ruby language ruby (version 1.8.7 or newer)
* The RubyGems packaging system (version 1.3.5 or newer)
* A working installation of SQLite (preferred), MySQL, or PostgreSQL
* Rails (version 2.3.5 or newer)

Check that current versions are installed on your computer:

ruby -v
gem -v
rails -v

You should have experience building a simple Rails application. Refer to http://guides.rubyonrails.org/ (Rails Guides) for help if you are a beginner.

0 comments on commit 0ca34ee

Please sign in to comment.