Added some documentation and some Usage examples

retailnext · Aug 18, 2011 · 516f01c · 516f01c
1 parent 9d73f4c
commit 516f01c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/README.rdoc b/README.rdoc
@@ -22,7 +22,13 @@ Install the gem:
 
 == Usage
 
-TBD...
+  # Creating and getting a timestamp from the UUID
+  uuid = SimpleUUID::UUID.new => <UUID#2278170300  .... >
+  uuid.to_time => Thu Aug 18 19:15:16 -0400 2011
+
+  # Given raw bytes from a source such as cassandra (using bytes from an existing UUID as an example)
+  bytes = SimpleUUID::UUID.new.bytes
+  SimpleUUID::UUID.to_time(bytes) => Thu Aug 18 19:15:16 -0400 2011
 
 == Reporting problems
 

diff --git a/lib/simple_uuid.rb b/lib/simple_uuid.rb
@@ -127,14 +127,17 @@ def eql?(other)
       other.respond_to?(:bytes) && bytes == other.bytes
     end
 
+    # Given raw bytes, return a time object
     def self.to_time(bytes)
       Time.at(total_usecs(bytes) / 1000000.0)
     end
 
+    # Return a time object
     def to_time
       self.class.to_time(@bytes)
     end
 
+    # Given raw bytes, return the total_usecs
     def self.total_usecs(bytes)
       elements = bytes.unpack("NnnQ")
       (elements[0] + (elements[1] << 32) + ((elements[2] & 0x0FFF) << 48) - GREGORIAN_EPOCH_OFFSET) / 10