Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme and Sample hocon for new settings #37

Open
to11mtm opened this issue Jan 12, 2024 · 1 comment
Open

Update Readme and Sample hocon for new settings #37

to11mtm opened this issue Jan 12, 2024 · 1 comment

Comments

@to11mtm
Copy link
Member

to11mtm commented Jan 12, 2024

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
Copy link
Member Author

to11mtm commented Nov 29, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant