Author: rezan
Date: Tue Aug 4 15:33:44 2015
New Revision: 1694076
URL: http://svn.apache.org/r1694076
Log:
readme update
Modified:
devicemap/trunk/clients/2.0/reference/README
Modified: devicemap/trunk/clients/2.0/reference/README
URL:
http://svn.apache.org/viewvc/devicemap/trunk/clients/2.0/reference/README?rev=1694076&r1=1694075&r2=1694076&view=diff
==============================================================================
--- devicemap/trunk/clients/2.0/reference/README (original)
+++ devicemap/trunk/clients/2.0/reference/README Tue Aug 4 15:33:44 2015
@@ -1,10 +1,62 @@
Apache DeviceMap 2.0 Reference Client
-https://svn.apache.org/repos/asf/devicemap/trunk/clients/2.0/reference/
+
+WHAT IS THIS?
+=============
+
+This is the reference client for Apache DeviceMap.
+
+Apache DeviceMap is primarily a device classification project. This is
+also known as device detection. Basically, give DeviceMap a string (like
+a User-Agent request header) and it will tell you what it is.
+
+DeviceMap 2.0 has extended the idea of classification into generic domains.
+The domain tells the DeviceMap client how to classify the input into a
+result. This will allow this project and 3rd parties to create their own
+domains and use them with standard DeviceMap 2.0 clients.
+
+This reference client is the starting point for:
+
+ * Creating, testing, and validating a 2.0 domain.
+
+ * Creating a client for a specific platform or language.
+
+
+2.0 SPECIFICATION
+=================
http://wiki.apache.org/devicemap/DataSpec2
+SOURCE
+======
+
+https://svn.apache.org/repos/asf/devicemap/trunk/clients/2.0/reference/
+
+The source is broken up into several components:
+
+ * src/Main.java
+ This is the driver for the reference client. It contains logic to parse
+ the command line and the test file.
+
+ * src/DeviceMapClient.java
+ This is the actual DeviceMap client. It is initialized with a pattern file
+ and an attribute file (or multiple). Once initialized, it can then classify
+ text and return back attribute maps.
+
+ * src/JsonFile.java
+ This parses a JSON file into something the DeviceMapClient can handle.
+
+ * src/Pattern.java
+ This is a pattern object.
+
+ * src/Attributes.java
+ This is the pattern attributes object.
+
+ * src/Transformer*.java
+ These are transformers.
+
+
COMPILE
=======
@@ -34,3 +86,4 @@ To run the reference_a domain:
You can also use the test harness:
./test.sh ../../../data/2.0/reference/a
+
