docs: add auto-detect package to README#58
Merged
Conversation
leodido
force-pushed
the
docs/readme-auto-detect
branch
from
c3ec39b to
684b77c
Compare
- Add auto package to feature list - Add Auto-detect usage section with code examples - Add NewParserAuto examples to octetcounting and nontransparent sections - Note minimum Go 1.22 requirement in Installation
Use rfc5424.NewParser and rfc5424.WithBestEffort for consistency with the rest of the README.
leodido
force-pushed
the
docs/readme-auto-detect
branch
from
684b77c to
a768eb0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The README had no mention of the
autopackage orNewParserAutointroduced in PR #54. This adds:auto.NewMachine, detection heuristic overview, format-specific options exampleNewParserAutoexample for mixed-format streamsNewParserAutoexample for mixed-format streamsAll code examples verified to compile and run.
How to test
Read the README and verify the examples match the current API.