Merge branch 'master' into develop

Author: mumez

README.md

@@ -3,11 +3,63 @@ msgpack-smalltalk
 
 MessagePack serialization library for various Smalltalk dialects.
 
-We are moving from [Google Code site](http://code.google.com/p/messagepack-st/). Old contents are still there.
+- Squeak
+- Pharo
+- VisualWorks
+- VA Smalltalk
+- Dolphin Smalltalk
+- GNU Smalltalk (Beta)
+- [Cuis](https://github.com/mumez/Cuis-Smalltalk-MessagePack)
 
-Currently, we have just put a [Cypress](https://github.com/CampSmalltalk/Cypress/blob/master/README.md)-based repository for the neutral accesses from various Smalltalk dialects.
+Sources are put as [Cypress](https://github.com/CampSmalltalk/Cypress/blob/master/README.md) for the neutral accesses from various Smalltalk dialects.
 
+## How to use ##
 
+### Serialization ###
+```Smalltalk
+MpMessagePack pack: <your object>
+```
+or:
+```Smalltalk
+<your object> messagePacked
+```
+
+### Deserialization ###
+```Smalltalk
+MpMessagePack unpack: msgpackBytes
+```
+or:
+```Smalltalk
+Object fromMessagePack: msgBytes
+```
+
+### Samples ###
+
+```Smalltalk
+map := Dictionary new.
+map at: 'someArray' asByteArray put: #(1 2.2 #[3 4 5]).
+packed := map messagePacked.
+(Object fromMessagePack: packed) inspect.
+```
+
+```Smalltalk
+writeStream := WriteStream on: ByteArray new.
+encoder := MpEncoder on: writeStream.
+encoder nextPut: 1.
+encoder nextPut: #(2 3).
+dic := Dictionary new.
+dic at: 4 put: 5.
+encoder nextPut: dic.
+encoder nextPut: 'four' asByteArray.
+bytes := encoder contents.
+readStream := ReadStream on: bytes.
+decoder := MpDecoder on: readStream.
+[decoder atEnd] whileFalse: [
+        Transcript cr; show: decoder next printString
+]
+```
+### How to install
+Please read [HowToInstall.md](<https://github.com/msgpack/msgpack-smalltalk/blob/master/doc/HowToInstall.md>).
 
 ### Loading the latest development version
 

doc/HowToInstall.md

@@ -54,7 +54,7 @@ http://code.google.com/p/messagepack-st/source/browse/#hg%2FVA%20Smalltalk
 
 ## Dolphin Smalltalk:
 
-Hosted on this site.
+Hosted on [Google Code site](<http://messagepack-st.googlecode.com>) (old version).
 
 Zipped: [MessagePack-Dolphin.zip](http://messagepack-st.googlecode.com/hg/Dolphin%20Smalltalk/MessagePack-Dolphin.zip).
 Sources: [MessagePack](http://code.google.com/p/messagepack-st/source/browse/#hg%2FDolphin%20Smalltalk%2FMessagePack).