README.rdoc in midas-guilded-0.2.9 vs README.rdoc in midas-guilded-0.3.0

- old
+ new

@@ -1,9 +1,10 @@ = guilded http://github.com/midas/guilded/tree/master + == DESCRIPTION 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. @@ -26,15 +27,20 @@ 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 gem. The Guilded gem contains the framework to build Guilded components. +Update: Due to the quality components, etc. being generated by the MooTools community and the general quality of the library, we +have decided to include support for it in Guilded as of release 0.3.0. + == 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 MooTools 1.2.3 library if a utilized component defines it as a dependency using the :mootools => true option + with the Guilder.add() method when defining the component. * 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. Simply define your custom functions within the g object. * Definition of convenience method $j(). Equivalent to jQuery() or $(). Guilded runs jQuery in no conflict mode, giving the $ @@ -51,10 +57,13 @@ single script tag for the cached version of these asset(s), when running in production mode. * Pass named data structures from the server to the client side environment for use with the Guilder.add_data() method. Once Guilded is initialized, the data structure will be instantiated for you with the name specified within the g object. * Execute custom JavaScript code after all Guilded components are initialized (ensuring everything you wish to use is instantiated) using the 'guildedInitialized' custom jQuery event defined on the body DOM element. +* g_javascript_include_tag view helper that will explicitly add JavaScript libraries to the libs collection to be included in the + assets. This helper will also resolve any libs to their full or compressed versions dependent on the current executing environment. + Additionally, the symbols :jquery and :mootools will be expanded to the lib version defined in the Guilded configuration. === 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 @@ -93,20 +102,25 @@ == REQUIREMENTS * jQuery 1.3.2 (included in Guilded) +== OPTIONALS + +* MooTools 1.2.3 (included in Guilded) + + == INSTALL gem sources -a http://gems.github.com sudo gem install midas-guilded == INSTALL FOR RAILS Add to environment file: - config.gem "guilded", :version => '0.1.9' + config.gem "guilded", :version => '0.2.9' Run: sudo rake:gems:install \ No newline at end of file