changeset 29:f84f521c7ea8

add README
author Mitchell Weggemans <mitchell.weggemans@monetdbsolutions.com>
date Thu, 06 May 2021 14:20:54 +0200 (2021-05-06)
parents c2070750ad20
children ee8a0bdbbacd
files README.md
diffstat 1 files changed, 33 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# MonetDB-Ruby
+
+Ruby driver for MonetDB
+
+## Installation
+
+First build a gem file starting from the given gemspec:
+
+```bash
+$ gem build ruby-monetdb-sql-0.2.gemspec
+```
+
+Then install the resulting gem with the command:
+
+```bash
+$ gem install --local ruby-monetdb-sql-0.2.gem
+```
+
+## Example
+```ruby
+require_relative 'MonetDB'
+
+conn = MonetDB.new
+conn.connect(user = "monetdb", passwd = "monetdb", lang = "sql", host="127.0.0.1", port = 50000, database_connection_name = "demo", auth_type = "SHA1")
+
+result =conn.query("SELECT 1")
+
+result.each_record do |record|
+  puts record
+end
+```
+
+A more extensive example can be found in /lib/example.rb
\ No newline at end of file