Skip to content

Commit 9e6316c

Browse files
committed
Add readme.md file
1 parent 5ce6fc5 commit 9e6316c

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

readme.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# XML Serializer for ReBus
2+
3+
## Why it was created?
4+
5+
To make transition from NServiceBus MSMQ to ReBus as much painless as possible.
6+
7+
## Getting started
8+
9+
```c#
10+
Configure.With(...)
11+
.Serialization(s => s.UseXmlSerializing(settings))
12+
//...
13+
```
14+
15+
## Example:
16+
17+
_Message body sent to queues_
18+
19+
```json
20+
//$type - TestMessage object
21+
{
22+
"GuidProp": "0576a0cd-13c7-4dc2-a74b-4e7419213f5a",
23+
"EnumProp": 1,
24+
"DateTimeProp": "2020-12-11T00:20:11.8711501"
25+
}
26+
```
27+
:arrow_down: :arrow_up:
28+
```xml
29+
<?xml version="1.0"?>
30+
<Messages xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
31+
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
32+
xmlns="http://tempuri.org/ReBus.Serializer.XML.UnitTests.Messages">
33+
<TestMessage>
34+
<GuidProp>0576a0cd-13c7-4dc2-a74b-4e7419213f5a</GuidProp>
35+
<EnumProp>Success</EnumProp>
36+
<DateTimeProp>2020-12-11T00:20:11.8711501</DateTimeProp>
37+
</TestMessage>
38+
</Messages>
39+
```
40+
41+
## Limitations
42+
43+
This serializer **does not** support serialization/deserialization of collections.
44+
45+
## Contribution
46+
47+
It would be great if you guys would help me improve this or bring up any issues. I will work on them in free time.

0 commit comments

Comments
 (0)