Updated README

README.textile

@@ -0,0 +1,38 @@
+h1. Rails 3, Mongoid,  Carrierwave, and Uploadify
+
+This is a demonstration application using:
+
+* Rails 3.0 — Best web framework ever
+* Mongoid — A MongoDB mapper for Rails
+* Carrierwave — Upload and attach files to Rails models
+* Uploadify — Flash based multi-file uploader
+
+Other depedencies:
+
+* RSpec 2.0 — Works well with Mongoid
+* JQuery — Prototype replacement, required by Uploadify
+* HAML — Much better than writing in ERB
+* RemarkableMongoid — Very useful in testing standard Mongoid associations
+
+
+h3. Uploadify
+
+http://www.uploadify.com/
+
+JQuery plugin that uses SWFObject to easily select and upload multiple files. Sensible defaults, good looking default buttons, excellent callback mechanism.
+
+This project adds rack middleware to correctly pass session data into Rails as well as properly handle Javascript calls using respond_to. It also uses RJS to dynamically update the browser as each image is uploaded and a thumbnail is created.
+
+
+h3. Carrierwave
+
+http://github.com/jnicklas/carrierwave
+
+Uploading mechanism using Rack Middleware to handle accept uploads and "mount" them to the model. Carrierwave is best at isolating all uploading functions from the model it's being attached to. Image is the mount point inside the photo model. The photo model is an embedded document inside the story model.
+
+
+h3. Mongoid
+
+http://mongoid.org/
+
+Mongoid is an excellent (and we think the best) ORM for MongoDB. It enables embedded documents as well as ActiveRecord style associations (called references). The documentation is good and is actively developed. It does not interfere with ActiveRecord so projects can use both in parallel.