Skip to content
This repository
Browse code

Update the overview doc.

  • Loading branch information...
commit 734590c609b17f55713133a02ea28451da42800d 1 parent ee6db0f
Sean Cribbs authored December 06, 2013

Showing 1 changed file with 11 additions and 3 deletions. Show diff stats Hide diff stats

  1. 14  doc/overview.edoc
14  doc/overview.edoc
... ...
@@ -1,6 +1,6 @@
1 1
 @author Basho Technologies, Inc.
2 2
 @copyright 2010-2013 Basho Technologies, Inc.
3  
-@version 1.4.1
  3
+@version 2.0.0pre
4 4
 @title Riak Client for Erlang
5 5
 @doc <p>The <code>riakc</code> application encapsulates the Erlang
6 6
 client for Riak. This client uses the Protocol Buffers transport
@@ -17,12 +17,20 @@ the one below to the <code>rebar.config</code> in your project.</p>
17 17
              {tag, "1.4.1"}}}
18 18
        ]}.</pre>
19 19
 
20  
-<p>The application consists of 2 modules:</p>
  20
+<p>The application consists of these primary modules:</p>
21 21
 
22 22
 <ul>
23 23
 <li><strong>riakc_pb_socket</strong> - connection management and execution of client commands. Usually you will start a connection process using <code>riakc_pb_socket:start_link/2,3</code>.</li>
24 24
 <li><strong>riakc_obj</strong> - accessor and mutator functions for the <code>riakc_obj</code> record that is sent to and returned from Key-Value operations.</li>
  25
+<li>Riak convergent datatypes are supported by the <strong>riakc_datatype</strong> behaviour and these modules:
  26
+  <ul>
  27
+    <li><strong>riakc_counter</strong></li>
  28
+    <li><strong>riakc_set</strong></li>
  29
+    <li><strong>riakc_map</strong> (with embedded
  30
+    types <strong>riakc_flag</strong>
  31
+    and <strong>riakc_register</strong>)</li>
  32
+  </ul>
  33
+</li>
25 34
 </ul>
26  
-
27 35
 <p><code>riakc</code> is licensed under the Apache v2 license.</p>
28 36
 @end

0 notes on commit 734590c

Please sign in to comment.
Something went wrong with that request. Please try again.