README.rdoc in msgpack-0.5.5 vs README.rdoc in msgpack-0.5.6
- old
+ new
@@ -15,11 +15,17 @@
Use RubyGems to install:
gem install msgpack
+or build msgpack-ruby and install:
+ bundle
+ rake
+ gem install --local pkg/msgpack
+
+
= Use cases
* Store objects efficiently serialized by msgpack on memcached or Redis
* In fact Redis supports msgpack in EVAL-scripts[http://redis.io/commands/eval]
* Upload data in efficient format from mobile devices such as smartphones
@@ -91,12 +97,32 @@
MessagePack for Ruby provides a buffer API so that you can read or write data by hand, not via Packer or Unpacker API.
This {MessagePack::Buffer}[http://ruby.msgpack.org/MessagePack/Buffer.html] is backed with a fixed-length shared memory pool which is very fast for small data (<= 4KB),
and has zero-copy capability which significantly affects performance to handle large binary data.
+= How to build and run tests
+Before building msgpack, you need to install bundler and dependencies.
+
+ gem install bundler
+ bundle install
+
+Then, you can run the tasks as follows:
+
+* Build
+
+ bundle exec rake build
+
+* Run tests
+
+ bundle exec rake spec
+
+* Generating docs
+
+ bundle exec rake doc
+
= Copyright
-Author:: FURUHASHI Sadayuki <frsyuki@gmail.com>
-Copyright:: Copyright (c) 2008-2012 FURUHASHI Sadayuki
+Author:: Sadayuki Furuhashi <frsyuki@gmail.com>
+Copyright:: Copyright (c) 2008-2013 Sadayuki Furuhashi
License:: Apache License, Version 2.0