JBossCache -- a replicated and transactional tree cache with AOP
==================================================================

Version 1.0 beta Nov, 2003

Requirements:
 - JDK 1.3 and up (tested under JDK 1.4)

Directory structure:
 - examples. Has couple of unit testing examples for both local,
   replicated, and aop cases. In addition, under etc directory
   there are sample configuration files for both TreeCache and
   TreeCacheAop.
 - docs. User doc and tutorial. See index.html
 - lib. Has the necessary libraries to run both cache and examples.
 - ant-dist. Ant distribution.

Examples:
 - under DOS, "build.bat" will display the available commands.
 - under Linux/Cygwin, "sh build.sh" will display the available commands.
 - currently commands available are: compile, clobber, run.bat, run.aop.bat,
   run.demo, and run.aop.demo
 - also see docs/Tutorial.html for demo

Sample usage for TreeCache:
    import org.jboss.cache.*;
    cache = new TreeCache();
    config = new PropertyConfigurator();
    // Needs to have a class path pointing to META-INF/local-service.xml
    config.configure(cache, "META-INF/local-service.xml");

    cache.start(); // need to start up the cache explicitly.
    cache.put("/a/b/c", key, value);
    cache.get("/a/b/c", key);
    ...

    cache.stop();   // stop the cache

Sample usage for TreeCacheAOP:
    import org.jboss.cache.*;
    cache = new TreeCacheAop();
    config = new PropertyConfigurator();
    // Needs to have a class path pointing to META-INF/local-service.xml
    config.configure(cache, "META-INF/local-service.xml");

    cache.start(); // need to start up the cache explicitly.
    cache.putObject("/a/b/c", obj);
    ...

    cache.stop();   // stop the cache

Problems:
 - Please report problems to the JBoss cache forum (http://www.jboss.org/forum.jsp?forum=157)
   or the JBoss dev mailing list

