README.rdoc in midas-guilded-0.0.5 vs README.rdoc in midas-guilded-0.0.6

@@ -1,12 +1,12 @@
 = guilded-base
 
-* http://github.com/midas/guilded-base/tree/master
+http://github.com/midas/guilded-base/tree/master
 
 == DESCRIPTION
 
-Warning: This project just started and there are no releases available yet.
+Warning: This project just started and there are no stable releases available yet.
 
 Guilded is a framework for building web based components centered around current web standards and best practices. The current 
 framework is written in ruby, but could be ported to other languages.
 
 Guilded intends to provide a toolset for creating and consuming reusable web components.  Currently, this problem domain is
@@ -24,47 +24,72 @@
 allow the jQuery plugin to be used outside of the Guilded project, if desired.
 
 Guilded also seeks to provide a standardized CSS framework for creating layouts that are reusable and predictable.
 
 Guilded will utilize the currently existing RubyGems system to package its components.  A new Guilded component will be packaged 
-in a Gem and have a dependency on the guilded-base gem.
+in a Gem and have a dependency on the guilded gem.
 
 The Guilded-Base gem contains the framework to build Guilded components.
 
 
 == FEATURES
 
+=== Centralized control of CSS and JavaScript assets needed to render a web page.
+* Automatic addition of jQuery 1.3.2 library.
+* Automatic addition of Yahoo's reset-min.css.
+* Redefinition of jQuery's $ method to $j and running jQuery in no conflict mode to allow other libraries to retain control 
+  of the $ method.
+* Definition of the g namespace to avoid JavaScript name collisions.
+* Definition of convenience method $jc().  Equivalent to jQuery( '.' + className ).
+* Definition of convenience method $jid().  Equivalent to jQuery( '#' + idName ). 
+* The assets required for each component are added by the author to a central data store.  When the view helper to create
+  the component is called, these assets are added to the asset store.  This results in a single method call with some options
+  to use a Guilded component.
+* For CSS assets, Guilded simply loops through the collection of CSS assets creating an HTML link tag for each asset, or one 
+  HTML link tag for the cached version of these asset(s), when running in production mode.
+* For JavaScript assets, Guilded loops through the collection of JavaScript assets creating an HTML script tag for each, or a
+  single script tag for the cached version of these asset(s), when running in production mode.
 
+=== Caching of CSS and JavaScript assets needed to render a web page.
+* The CSS assets are cached to form one file.  In addition, the JavaScript assets are cached to form one file.  These files are 
+  named by sorting and concatenating into a single string the names of each individual respective asset.  This string is then hashed 
+  to generate a reproducable unique string.  This file naming technique allows Guilded to find cached asset files that 
+  match a combination of Guilded components, not an action, URI, etc.  Thus, one file for a certain combination of Guilded 
+  components is generated and then reused on any page where the combination appears.
+
+=== Automatic choosing of packed, compressed or minified JavaScript files when in production mode.
+* In production mode, Guilded automatically looks for a .pack, .compressed or .min version of the JavaScript assets.  If one of 
+  these is found, it includes it, otherwise, it includes the version specified by the author in the view helper.  This is usually an unpacked version of the file.
+
 == PROBLEMS
 
 
 
 == REQUIREMENTS
 
-jQuery
+* jQuery 1.3.2 (included in Guilded)
 
 
 == INSTALL
 
-gem sources -a http://gems.github.com
+  gem sources -a http://gems.github.com
+  sudo gem install midas-guilded
 
-sudo gem install midas-guilded
 
-
 == INSTALL FOR RAILS
 
 Add to environment file:
 
-	config.gem "guilded", :version => '0.0.3'
+  config.gem "guilded", :version => '0.0.5'
 
 Run:
 
-	sudo rake:gems:install
+  sudo rake:gems:install
 	
 Generate:
 
-	script/generate guilded_config
-	script/generate guilded_assets
+  script/generate guilded_config
+  script/generate guilded_assets
 
 
 Edit the settings file at config/initializers/load_guilded_settings.rb.  Change any of these settings to reflect how
 you would like Guilded to be configured.  If you change where any file(s) are configured to be located, then also move 
 the respective file(s).
\ No newline at end of file