lib/duckdb/result.rb in duckdb-0.0.5 vs lib/duckdb/result.rb in duckdb-0.0.6

@@ -1,19 +1,38 @@
 module DuckDB
+  # The Result class encapsulates a execute result of DuckDB database.
+  #
+  # The usage is as follows:
+  #
+  #   require 'duckdb'
+  #
+  #   db = DuckDB::Database.open # database in memory
+  #   con = db.connect
+  #
+  #   con.execute('CREATE TABLE users (id INTEGER, name VARCHAR(30))')
+  #
+  #   con.execute("INSERT into users VALUES(1, 'Alice')")
+  #   con.execute("INSERT into users VALUES(2, 'Bob')")
+  #   con.execute("INSERT into users VALUES(3, 'Cathy')")
+  #
+  #   result = con.execute('SELECT * from users')
+  #   result.each do |row|
+  #     p row
+  #   end
   class Result
     include Enumerable
   end
 end