more documentation.

karupanerura · Feb 21, 2015 · 3b5c340 · 3b5c340
1 parent 2ba8c35
commit 3b5c340
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -75,8 +75,13 @@ Test::SharedObject provides atomic data operation between multiple process.
         });
 
 - $shared->set($value)
+
+    Set `$value` as shared value.
+    The syntactic sugar for `$shared->txn()`.
+
 - my $value = $shared->get()
 
+    Get shared value.
     The syntactic sugar for `$shared->txn()`.
 
 # LICENSE

diff --git a/lib/Test/SharedObject.pm b/lib/Test/SharedObject.pm
@@ -149,8 +149,12 @@ Bad Example:
 
 =item $shared->set($value)
 
+Set C<$value> as shared value.
+The syntactic sugar for C<$shared-E<gt>txn()>.
+
 =item my $value = $shared->get()
 
+Get shared value.
 The syntactic sugar for C<$shared-E<gt>txn()>.
 
 =back