Mercurial > hg > Members > sugi > MessagePack-java

annotate README.md @ 1:769ba8da0840

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add get serialized ByteArray method
author one
date Sat, 18 Oct 2014 21:37:12 +0900
parents cb825acd883a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cb825acd883a first commit
sugi
parents:
diff changeset
1 # MessagePack for Java
cb825acd883a first commit
sugi
parents:
diff changeset
2
cb825acd883a first commit
sugi
parents:
diff changeset
3 [MessagePack](http://msgpack.org/) is an efficient binary serialization format.
cb825acd883a first commit
sugi
parents:
diff changeset
4 It lets you exchange data among multiple languages like JSON but it's faster and smaller.
cb825acd883a first commit
sugi
parents:
diff changeset
5 For example, small integers (like flags or error code) are encoded into a single byte,
cb825acd883a first commit
sugi
parents:
diff changeset
6 and typical short strings only require an extra byte in addition to the strings themselves.
cb825acd883a first commit
sugi
parents:
diff changeset
7
cb825acd883a first commit
sugi
parents:
diff changeset
8 You may be interested in how msgpack-java is faster than the other libraries.
cb825acd883a first commit
sugi
parents:
diff changeset
9 To know this, please see [jvm-serializers](https://github.com/eishay/jvm-serializers/wiki), which is one of well-known benchmarks for comparing Java libraries of data serialization.
cb825acd883a first commit
sugi
parents:
diff changeset
10
cb825acd883a first commit
sugi
parents:
diff changeset
11 [![Build Status](https://travis-ci.org/msgpack/msgpack-java.png?branch=master)](https://travis-ci.org/msgpack/msgpack-java)
cb825acd883a first commit
sugi
parents:
diff changeset
12
cb825acd883a first commit
sugi
parents:
diff changeset
13 ## Quick start
cb825acd883a first commit
sugi
parents:
diff changeset
14
cb825acd883a first commit
sugi
parents:
diff changeset
15 Quick start for msgpack-java is available at [Wiki](https://github.com/msgpack/msgpack-java/wiki/QuickStart).
cb825acd883a first commit
sugi
parents:
diff changeset
16
cb825acd883a first commit
sugi
parents:
diff changeset
17
cb825acd883a first commit
sugi
parents:
diff changeset
18 ## Build
cb825acd883a first commit
sugi
parents:
diff changeset
19
cb825acd883a first commit
sugi
parents:
diff changeset
20 To build the JAR file of MessagePack, you need to install Maven (http://maven.apache.org), then type the following command:
cb825acd883a first commit
sugi
parents:
diff changeset
21
cb825acd883a first commit
sugi
parents:
diff changeset
22 $ mvn package
cb825acd883a first commit
sugi
parents:
diff changeset
23
cb825acd883a first commit
sugi
parents:
diff changeset
24 To locally install the project, type
cb825acd883a first commit
sugi
parents:
diff changeset
25
cb825acd883a first commit
sugi
parents:
diff changeset
26 $ mvn install
cb825acd883a first commit
sugi
parents:
diff changeset
27
cb825acd883a first commit
sugi
parents:
diff changeset
28 To generate project files (.project, .classpath) for Eclipse, do
cb825acd883a first commit
sugi
parents:
diff changeset
29
cb825acd883a first commit
sugi
parents:
diff changeset
30 $ mvn eclipse:eclipse
cb825acd883a first commit
sugi
parents:
diff changeset
31
cb825acd883a first commit
sugi
parents:
diff changeset
32 then import the folder from your Eclipse.
cb825acd883a first commit
sugi
parents:
diff changeset
33
cb825acd883a first commit
sugi
parents:
diff changeset
34 Next, open the preference page in Eclipse and add the CLASSPATH variable:
cb825acd883a first commit
sugi
parents:
diff changeset
35
cb825acd883a first commit
sugi
parents:
diff changeset
36 M2_REPO = $HOME/.m2/repository
cb825acd883a first commit
sugi
parents:
diff changeset
37
cb825acd883a first commit
sugi
parents:
diff changeset
38 where $HOME is your home directory. In Windows XP, $HOME is:
cb825acd883a first commit
sugi
parents:
diff changeset
39
cb825acd883a first commit
sugi
parents:
diff changeset
40 C:/Documents and Settings/(user name)/.m2/repository
cb825acd883a first commit
sugi
parents:
diff changeset
41
cb825acd883a first commit
sugi
parents:
diff changeset
42
cb825acd883a first commit
sugi
parents:
diff changeset
43 ## How to release
cb825acd883a first commit
sugi
parents:
diff changeset
44
cb825acd883a first commit
sugi
parents:
diff changeset
45 To relese the project (compile, test, tagging, deploy), please use the commands as follows:
cb825acd883a first commit
sugi
parents:
diff changeset
46
cb825acd883a first commit
sugi
parents:
diff changeset
47 $ mvn release:prepare
cb825acd883a first commit
sugi
parents:
diff changeset
48 $ mvn release:perform
cb825acd883a first commit
sugi
parents:
diff changeset
49
cb825acd883a first commit
sugi
parents:
diff changeset
50 ## License
cb825acd883a first commit
sugi
parents:
diff changeset
51
cb825acd883a first commit
sugi
parents:
diff changeset
52 This software is distributed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
cb825acd883a first commit
sugi
parents:
diff changeset
53