README.txt

= Ehcache for JRuby

http://github.com/dylanz/ehcache


== DESCRIPTION:

Ehcache is a simplified JRuby interface to Java's (JSR(107) compliant) Ehcache.
Simplified meaning that it should work out-of-the-box, but a lot of native
methods haven't been interfaced yet, as they weren't needed.  Configuration
occurs in config/ehcache.yml, and should support all the configuration
options available.

Some biased and non-biased Ehcache VS Memcache articles:
http://gregluck.com/blog/archives/2007/05/comparing_memca.html
http://feedblog.org/2007/05/21/unfair-benchmarks-of-ehcache-vs-memcached
http://blog.aristotlesdog.com/2008/05/01/memcached_vs_ehcache/
http://www.hugotroche.com/my_weblog/2008/06/ehcache-vs-memc.html

For more information on Ehcache, see:
http://ehcache.sourceforge.net/

Configuration, Code Samples and everything else, see:
http://ehcache.sourceforge.net/EhcacheUserGuide.html

Google Groups:
http://groups.google.com/group/ehcache-jruby

Tickets:
http://dylanz.lighthouseapp.com/projects/14518-ehcache-jruby/overview


== BASIC USAGE:

manager = CacheManager.new
cache = manager.cache
cache.put("key", "value", {:ttl => 120})
cache.get("key")
manager.shutdown


== RAILS:

An EhcacheStore is available for use within Rails, so all the native
Rails caching methods are supported.  Make sure your config/environments/*,
are setup to support caching, eg: config.action_controller.perform_caching = true

1) From your RAILS_ROOT, run this command:
     - ehcache rails  ## just copies ehcache_store.rb into lib/ at the moment

2) In your environment.rb, specify:
     - config.cache_store = :ehcache_store

3) Start server in production mode.  Important.

4) Cache stuff


== REQUIREMENTS:

Tested with JRuby 1.1.2.


== INSTALL:

sudo gem install ehcache


== LICENSE:
Copyright (c) 2008 Dylan Stamat <dstamat@elctech.com>

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.