README in interlock-1.1 vs README in interlock-1.2

- old
+ new

@@ -3,14 +3,16 @@ A Rails plugin for maintainable and high-efficiency caching. == License -Copyright 2007 Cloudburst, LLC. Licensed under the AFL 3; see the included LICENSE file. Portions copyright 2006 Chris Wanstrath and used with permission. +Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. Portions copyright 2006 Chris Wanstrath and used with permission. -The public certificate for the gem is at http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem. +The public certificate for the gem is here[http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem]. +If you use this software, please {make a donation}[http://blog.evanweaver.com/donate/], or {recommend Evan}[http://www.workingwithrails.com/person/7739-evan-weaver] at Working with Rails. + == Requirements * memcached (http://www.danga.com/memcached) * memcache-client gem * Rails 1.2.6 @@ -25,30 +27,33 @@ == Installation First, compile and install memcached itself. Get a memcached server running. -You also need the <tt>memcache-client</tt> gem: +You also need either <tt>memcache-client</tt> or {memcached}[http://blog.evanweaver.com/files/doc/fauna/memcached]: sudo gem install memcache-client Then, install the plugin: script/plugin install -x svn://rubyforge.org/var/svn/fauna/interlock/trunk Lastly, configure your Rails app for memcached by creating a <tt>config/memcached.yml</tt> file. The format is compatible with Cache_fu: defaults: namespace: myapp sessions: false + client: memcache-client development: servers: - - localhost:11211 # Default port + - 127.0.0.1:11211 # Default host and port production: servers - 10.12.128.1 - 10.12.128.2 Now you're ready to go. + +Note that if you have {memcached 0.7}[http://blog.evanweaver.com/files/doc/fauna/memcached], you can use <tt>client: memcached</tt> for better performance. == Usage Interlock provides two similar caching methods: <tt>behavior_cache</tt> for controllers and <tt>view_cache</tt> for views. They both accept an optional list or hash of model dependencies, and an optional <tt>:tag</tt> keypair. <tt>view_cache</tt> also accepts a <tt>:ttl</tt> keypair. @@ -104,8 +109,8 @@ * http://blog.evanweaver.com/articles/2007/12/13/better-rails-caching/ * http://www.socialtext.net/memcached/index.cgi?faq == Reporting problems -* http://rubyforge.org/forum/forum.php?forum_id=19835 +The support forum is here[http://rubyforge.org/forum/forum.php?forum_id=19835]. Patches and contributions are very welcome. Please note that contributors are required to assign copyright for their additions to Cloudburst, LLC.