README fleshed out

nmanzi · Oct 6, 2011 · c610fcd · c610fcd
1 parent 0f1d023
commit c610fcd
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 261 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+SubbySub
+========
+
+SubbySub is a URL shortener that works with subdomains rather than paths. Uses SQLlite3 as DB.
+
+Example
+-------
+
+[http://github.hadric.us](http://github.hadric.us) (redirects to my GitHub Profile)
+
+Installation
+------------
+
+1. Clone this repo
+2. Set up a wildcard subdomain DNS entry to point to your server (so that all subdomains resolve to the one address)
+	* e.g. *.hadric.us
+3. rake db:migrate
+
+Thanks
+------
+
+* Ryan Bates for the [Subdomains RailsCast](http://railscasts.com/episodes/221-subdomains-in-rails-3)
+* PerfectLine for [validate_url](https://github.com/perfectline/validates_url)
+* Thomas McDonald for [bootstrap-sass](https://github.com/thomas-mcdonald/bootstrap-sass)