--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Thu Feb 17 10:31:40 2011 +0000
@@ -0,0 +1,49 @@
+============
+DEPENDENCIES
+============
+
+- JUnit 3.8.1
+- Log4j 1.2.14
+- Restlet 2.0-SNAPSHOT
+- Restlet-XML 2.0-SNAPSHOT
+
+
+============================
+COMPILATION AND INSTALLATION
+============================
+
+This project is based on maven2. To compile/install this client, just do:
+
+    mvn compile package
+
+The result will be an jar-archive in the ``target`` directory.
+
+If you want to use the contrib script ``run.sh`` (see below), you will need
+the jars of the dependencies as well. Therefore, just do:
+
+    mvn compile package dependency:copy-dependencies
+
+This command will compile the sources, build a jar of those and download the
+depending jar archives to ``target/dependency``.
+
+
+=============
+CONFIGURATION
+=============
+
+Currently, this client reads two configuration files:
+
+    - the artifact configuration (conf/demo-config.conf)
+    - the logging configuration (conf/log4j.properties)
+
+
+==================
+RUNNING THE CLIENT
+==================
+
+There is a bash script in the ``contrib`` directory. This might be used to
+start the console based client. Note, that you need the jars of the depending
+libraries in the ``target`` directory.
+
+    sh bin/run.sh
+