Mercurial > hg > Members > sugi > MessagePack-java
comparison README.md @ 0:cb825acd883a
first commit
| author | sugi |
|---|---|
| date | Sat, 18 Oct 2014 15:06:15 +0900 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:cb825acd883a |
|---|---|
| 1 # MessagePack for Java | |
| 2 | |
| 3 [MessagePack](http://msgpack.org/) is an efficient binary serialization format. | |
| 4 It lets you exchange data among multiple languages like JSON but it's faster and smaller. | |
| 5 For example, small integers (like flags or error code) are encoded into a single byte, | |
| 6 and typical short strings only require an extra byte in addition to the strings themselves. | |
| 7 | |
| 8 You may be interested in how msgpack-java is faster than the other libraries. | |
| 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. | |
| 10 | |
| 11 [](https://travis-ci.org/msgpack/msgpack-java) | |
| 12 | |
| 13 ## Quick start | |
| 14 | |
| 15 Quick start for msgpack-java is available at [Wiki](https://github.com/msgpack/msgpack-java/wiki/QuickStart). | |
| 16 | |
| 17 | |
| 18 ## Build | |
| 19 | |
| 20 To build the JAR file of MessagePack, you need to install Maven (http://maven.apache.org), then type the following command: | |
| 21 | |
| 22 $ mvn package | |
| 23 | |
| 24 To locally install the project, type | |
| 25 | |
| 26 $ mvn install | |
| 27 | |
| 28 To generate project files (.project, .classpath) for Eclipse, do | |
| 29 | |
| 30 $ mvn eclipse:eclipse | |
| 31 | |
| 32 then import the folder from your Eclipse. | |
| 33 | |
| 34 Next, open the preference page in Eclipse and add the CLASSPATH variable: | |
| 35 | |
| 36 M2_REPO = $HOME/.m2/repository | |
| 37 | |
| 38 where $HOME is your home directory. In Windows XP, $HOME is: | |
| 39 | |
| 40 C:/Documents and Settings/(user name)/.m2/repository | |
| 41 | |
| 42 | |
| 43 ## How to release | |
| 44 | |
| 45 To relese the project (compile, test, tagging, deploy), please use the commands as follows: | |
| 46 | |
| 47 $ mvn release:prepare | |
| 48 $ mvn release:perform | |
| 49 | |
| 50 ## License | |
| 51 | |
| 52 This software is distributed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). | |
| 53 |