diff --git a/README.md b/README.md index cfbacbc..e44bfbc 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ qmsgpack [![Build Status](https://travis-ci.org/romixlab/qmsgpack.svg?branch=mas MessagePack for Qt +Documentation +------------- +Complete documentation is available here: [mp.marsw.ru](http://msgpack.marsworks.ru/) (still working on it) + Installation ------------ Clone repository: @@ -46,6 +50,10 @@ By default these Qt types are supported: `Int, UInt, LongLong, ULongLong, Double Also you can provide packer and unpacker functions for any other type (even for user type defined via `Q_DECLARE_METATYPE`) or MsgPack type. +Qt types and User types +----------------------- +There is packers and unpackers for QColor, QTime, QDate, QDateTime, QPoint, QSize, QRect. Also you can create your own packer/unpacker methods for Qt or your own types. See [docs](http://msgpack.marsworks.ru/) for details. + Thread-safety ------------- At this time it is not safe to call `MsgPack::registerPacker`, `MsgPack::registerUnpacker` and `MsgPack::setCompatibilityModeEnabled` from different threads. diff --git a/msgpack.org.md b/msgpack.org.md index 51ddeb4..7d58df2 100644 --- a/msgpack.org.md +++ b/msgpack.org.md @@ -1,5 +1,6 @@ MessagePack for Qt ================== +Full documentation is here [mp.marsw.ru](http://msgpack.marsworks.ru/) Installation ------------ @@ -40,3 +41,7 @@ double b; QSting s; stream >> a >> b >> s; ~~~ + +Qt types and User types +----------------------- +There is packers and unpackers for QColor, QTime, QDate, QDateTime, QPoint, QSize, QRect. Also you can create your own packer/unpacker methods for Qt or your own types. See [docs](http://msgpack.marsworks.ru/) for details.