Update Readme and Sample hocon for new settings

akkadotnet / Akka.Serialization.MessagePack

Akka.NET serialization with MessagePack

Apache License 2.0

14 stars 8 forks source link

Update Readme and Sample hocon for new settings #37

Open to11mtm opened 10 months ago

to11mtm commented 10 months ago

We don't have documentation around how to use BackwardsCompatibleSurrogatedFormatter, let alone in a way useful to users (If they REALLY want to for some reason, they'll probably have to override a serializerID or similar.

Also we should provide some docs and explanation around:

LZ4 Settings
converters vs converters-override
- May be worth providing an example of how to 'override' TypelessFormatter while safely respecting Akka surrogates, etc.

to11mtm commented 3 days ago

Actually TBH I think the docs could use a good bit of love in general.

This shouldn't be hard, the library is simple, but we should try to give some good information to make people understand options.