summaryrefslogtreecommitdiff
path: root/ruby/rbinit.c
diff options
context:
space:
mode:
Diffstat (limited to 'ruby/rbinit.c')
-rw-r--r--ruby/rbinit.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/ruby/rbinit.c b/ruby/rbinit.c
index 80d1d8c..050abde 100644
--- a/ruby/rbinit.c
+++ b/ruby/rbinit.c
@@ -20,6 +20,18 @@
static VALUE mMessagePack;
+/**
+ * Document-module: MessagePack
+ *
+ * MessagePack is a binary-based efficient object serialization library.
+ * It enables to exchange structured objects between many languages like JSON.
+ * But unlike JSON, it is very fast and small.
+ *
+ * require 'msgpack'
+ * msg = [1,2,3].to_msgpack #=> "\x93\x01\x02\x03"
+ * MessagePack.unpack(msg) #=> [1,2,3]
+ *
+ */
void Init_msgpack(void)
{
mMessagePack = rb_define_module("MessagePack");