Skip to content

Commit ef00902

Browse files
author
pfeatherstone
committed
updated README.md
1 parent 81960fa commit ef00902

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# msgpack_cpp
22
C++ header-only msgpack library using kiss principle
33

4-
# Example
4+
## Example
55

6-
## High-level objects
6+
### High-level objects
77

8-
### `std::tuple`
8+
#### `std::tuple`
99

1010
```
1111
using namespace msgpackcpp;
@@ -27,7 +27,7 @@ auto in = source(buf);
2727
deserialize(in, a);
2828
```
2929

30-
### `std::vector`
30+
#### `std::vector`
3131

3232
```
3333
using namespace msgpackcpp;
@@ -47,7 +47,7 @@ auto in = source(sin);
4747
deserialize(in, v2);
4848
```
4949

50-
### `std::map`
50+
#### `std::map`
5151

5252
```
5353
using namespace msgpackcpp;
@@ -63,7 +63,7 @@ auto in = source(buf);
6363
deserialize(in, b);
6464
```
6565

66-
### Custom object
66+
#### Custom object
6767

6868
Option 1 : defined `serialize()` and `deserialize()` functions in the same namespace as your custom struct. This will get picked up by ADL.
6969

@@ -146,4 +146,12 @@ serialize(out, a, /*as_map=*/true);
146146
147147
auto in = source(buf);
148148
deserialize(in, b, /*as_map=*/true);
149-
```
149+
```
150+
151+
## Installation
152+
153+
Just copy the contents of the include folder in your project with `msgpack_describe.h` as an optional header.
154+
155+
## Dependencies
156+
157+
You just need a C++17 compiler. If you want to avail yourself of the convenient Boost.Describe integration in `msgpack_describe.h`, then you'll require that Boost library.

0 commit comments

Comments
 (0)